Metadata-Version: 2.4
Name: doc8-custom-ignores
Version: 2026.7.29.1
Summary: Configure additional doc8 D000 ignores.
Author-email: Adam Dangoor <adamdangoor@gmail.com>
License: MIT License
        
        Copyright (c) 2026 Adam Dangoor
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Documentation, https://adamtheturtle.github.io/doc8-custom-ignores/
Project-URL: Source, https://github.com/adamtheturtle/doc8-custom-ignores
Keywords: doc8,docutils,lint,restructuredtext
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Quality Assurance
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: doc8>=2.0.0
Provides-Extra: dev
Requires-Dist: actionlint-py==1.7.12.24; extra == "dev"
Requires-Dist: check-manifest==0.51; extra == "dev"
Requires-Dist: deptry==0.25.1; extra == "dev"
Requires-Dist: doccmd==2026.7.19; python_version >= "3.11" and extra == "dev"
Requires-Dist: furo==2025.12.19; extra == "dev"
Requires-Dist: interrogate==1.7.0; extra == "dev"
Requires-Dist: mypy[faster-cache]==2.3.0; extra == "dev"
Requires-Dist: mypy-strict-kwargs==2026.7.19.1; python_version >= "3.11" and extra == "dev"
Requires-Dist: prek==0.4.11; extra == "dev"
Requires-Dist: pydocstringformatter==1.0.0; python_version >= "3.11" and extra == "dev"
Requires-Dist: pylint[spelling]==4.0.6; extra == "dev"
Requires-Dist: pylint-per-file-ignores==3.2.1; extra == "dev"
Requires-Dist: pyproject-fmt==2.26.0; extra == "dev"
Requires-Dist: pyrefly==1.1.1; extra == "dev"
Requires-Dist: pyright==1.1.411; extra == "dev"
Requires-Dist: pyroma==5.0.1; extra == "dev"
Requires-Dist: pytest==9.1.1; extra == "dev"
Requires-Dist: pytest-cov==7.1.0; extra == "dev"
Requires-Dist: pyyaml==6.0.3; extra == "dev"
Requires-Dist: ruff==0.16.0; extra == "dev"
Requires-Dist: shellcheck-py==0.11.0.1; extra == "dev"
Requires-Dist: shfmt-py==4.0.0; extra == "dev"
Requires-Dist: sphinx>=8.1.3; extra == "dev"
Requires-Dist: sphinx-copybutton==0.5.2; extra == "dev"
Requires-Dist: sphinx-lint==1.0.2; extra == "dev"
Requires-Dist: sphinx-pyproject==0.3.0; extra == "dev"
Requires-Dist: sphinx-substitution-extensions==2026.6.17; python_version >= "3.11" and extra == "dev"
Requires-Dist: sphinxcontrib-spelling==8.0.2; extra == "dev"
Requires-Dist: strict-kwargs==2026.7.24; python_version >= "3.11" and extra == "dev"
Requires-Dist: towncrier==25.8.0; extra == "dev"
Requires-Dist: ty==0.0.64; extra == "dev"
Requires-Dist: vulture==2.16; extra == "dev"
Requires-Dist: yamlfix==1.19.1; extra == "dev"
Requires-Dist: zizmor==1.28.0; extra == "dev"
Provides-Extra: release
Requires-Dist: check-wheel-contents==0.6.3; extra == "release"
Requires-Dist: towncrier==25.8.0; extra == "release"
Dynamic: license-file

===================
doc8-custom-ignores
===================

|PyPI| |Python versions| |CI|

Configure additional doc8 ``D000`` ignores in ``pyproject.toml``.

Install
-------

.. code-block:: console

   $ pip install doc8-custom-ignores

The plugin is discovered automatically by doc8.

Configure
---------

Prefer exact messages:

.. code-block:: toml

   [tool.doc8]
   ignore-messages = [
       """Error in "include" directive:
   unknown option: "path-substitutions".""",
   ]

Regular expressions are available when an exact message is not suitable:

.. code-block:: toml

   [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``.

.. |PyPI| image:: https://img.shields.io/pypi/v/doc8-custom-ignores
   :target: https://pypi.org/project/doc8-custom-ignores/
.. |Python versions| image:: https://img.shields.io/pypi/pyversions/doc8-custom-ignores
   :target: https://pypi.org/project/doc8-custom-ignores/
.. |CI| image:: https://github.com/adamtheturtle/doc8-custom-ignores/actions/workflows/ci.yml/badge.svg
   :target: https://github.com/adamtheturtle/doc8-custom-ignores/actions/workflows/ci.yml
