Configure additional doc8 D000 ignores.
Project Links
Meta
Author: Adam Dangoor
Requires Python: >=3.10
Classifiers
Development Status
- 4 - Beta
Environment
- Console
License
- OSI Approved :: MIT License
Operating System
- Microsoft :: Windows
- POSIX
Programming Language
- Python :: 3 :: Only
- Python :: 3.10
- Python :: 3.11
- Python :: 3.12
- Python :: 3.13
- Python :: 3.14
Topic
- Documentation
- Software Development :: Quality Assurance
Configure additional doc8 D000 ignores in pyproject.toml.
Install
$ pip install doc8-custom-ignoresThe plugin is discovered automatically by doc8.
Configure
Prefer exact messages:
[tool.doc8]
ignore-messages = [
"""Error in "include" directive:
unknown option: "path-substitutions".""",
]Regular expressions are available when an exact message is not suitable:
[tool.doc8]
ignore-regex = [
'''^Error in "include" directive:\nunknown option: "path-substitutions"\.$''',
]Patterns use Python’s regular-expression syntax. Both settings follow doc8’s default behavior and are disabled by doc8 --no-sphinx.
