Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add example for pyproject.toml config #149

Merged
merged 2 commits into from
Feb 15, 2024
Merged

Add example for pyproject.toml config #149

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
07c10bd
Add example for pyproject.toml config
q-wertz Feb 15, 2024
ca7dff9
Fix added example
q-wertz Feb 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.rst
View file
Open in desktop
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
Loading