Merge branch 'main' into fix-relative-path

.pre-commit-config.yaml

@@ -5,27 +5,27 @@ default_language_version:
   python: python3.10
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0  # Use the ref you want to point at
+    rev: v4.5.0  # Use the ref you want to point at
     hooks:
     - id: trailing-whitespace
     - id: check-yaml
     - id: end-of-file-fixer
     - id: trailing-whitespace
     - id: check-executables-have-shebangs
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.3.1
+    rev: v3.15.0
     hooks:
       - id: pyupgrade
   - repo: https://github.com/psf/black
-    rev: 23.1.0
+    rev: 24.2.0
     hooks:
       - id: black
   - repo: https://github.com/pycqa/flake8
-    rev: 6.0.0
+    rev: 7.0.0
     hooks:
       - id: flake8
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.1.1
+    rev: v1.8.0
     hooks:
       - id: mypy
         # empty args needed in order to match mypy cli behavior
@@ -37,7 +37,7 @@ repos:
           - types-setuptools
           - types-docutils
   - repo: https://github.com/PyCQA/pylint
-    rev: v2.17.0
+    rev: v3.0.3
     hooks:
       - id: pylint
         additional_dependencies:

README.rst

@@ -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).

src/doc8/__init__.py

@@ -1,4 +1,5 @@
 """doc8 - A docutils linter."""
+
 from __future__ import annotations
 from doc8.version import __version__
 from doc8.main import doc8  # noqa