Skip to content

Commit

Permalink
Add example for pyproject.toml config (#149)
Browse files Browse the repository at this point in the history
* Add example for pyproject.toml config

* Fix added example
  • Loading branch information
q-wertz authored Feb 15, 2024
1 parent 1eb6f1d commit 9100d53
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,14 @@ An example section that can be placed into one of these files::
verbose=1
ignore-path-errors=/tmp/other_thing.rst;D001;D002


An example for the ``pyproject.toml`` file::

[tool.doc8]

ignore = ["D001"]
allow-long-titles = true

**Note:** The option names are the same as the command line ones (with the
only variation of this being the ``no-sphinx`` option which from the
configuration file will be ``sphinx`` instead).
Expand Down

0 comments on commit 9100d53

Please sign in to comment.