Skip to content

Commit 9100d53

Browse files
authored
Add example for pyproject.toml config (#149)
* Add example for pyproject.toml config * Fix added example
1 parent 1eb6f1d commit 9100d53

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.rst

+8
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,14 @@ An example section that can be placed into one of these files::
119119
verbose=1
120120
ignore-path-errors=/tmp/other_thing.rst;D001;D002
121121

122+
123+
An example for the ``pyproject.toml`` file::
124+
125+
[tool.doc8]
126+
127+
ignore = ["D001"]
128+
allow-long-titles = true
129+
122130
**Note:** The option names are the same as the command line ones (with the
123131
only variation of this being the ``no-sphinx`` option which from the
124132
configuration file will be ``sphinx`` instead).

0 commit comments

Comments
 (0)