Move the extension logic to the .ext submodule

sphinx-contrib · Sep 3, 2022 · 37cdf28 · 37cdf28
1 parent 0b522bd
commit 37cdf28
Show file tree

Hide file tree

Showing 7 changed files with 429 additions and 412 deletions.
diff --git a/.flake8 b/.flake8
@@ -63,12 +63,12 @@ max-line-length = 79
 # Allow certain violations in certain files:
 per-file-ignores =
 
-  # E800 reports a lot of false-positives for legit
-  # tool-related comments;
-  # WPS412 logic of an extension is in __init__.py file;
+  # WPS412 logic of an extension is in __init__.py file
+  # F401   imported but unused
+  src/sphinxcontrib/towncrier/__init__.py: F401, WPS412
   # FIXME: WPS201 too many imports
   # FIXME: WPS402 too many `noqa`s
-  src/sphinxcontrib/towncrier/__init__.py: E800, WPS201, WPS402, WPS412
+  src/sphinxcontrib/towncrier/ext.py: WPS201, WPS402
 
   # There are multiple `assert`s (S101)
   # and subprocesses (import – S404; call – S603) in tests;
@@ -94,6 +94,7 @@ pytest-parametrize-values-row-type = tuple
 rst-roles =
     # Built-in Sphinx roles:
     class,
+    file,
     py:class,
     py:meth,
     # Sphinx's internal role:

diff --git a/README.rst b/README.rst
@@ -34,7 +34,7 @@ How to use this?
 
 .. code-block:: python
 
-    extensions = ['sphinxcontrib.towncrier']
+    extensions = ['sphinxcontrib.towncrier.ext']
 
     # Options: draft/sphinx-version/sphinx-release
     towncrier_draft_autoversion_mode = 'draft'

diff --git a/docs/change-notes-layout.rst b/docs/change-notes-layout.rst
@@ -189,7 +189,7 @@ with ``towncrier_draft_``.
         'sphinx.ext.intersphinx',
 
         # Third-party extensions:
-        'sphinxcontrib.towncrier',  # provides `towncrier-draft-entries` directive
+        'sphinxcontrib.towncrier.ext',  # provides `.. towncrier-draft-entries::`
     ]
 
     exclude_patterns = [

diff --git a/docs/conf.py b/docs/conf.py
@@ -73,7 +73,7 @@
     'sphinxcontrib.apidoc',
 
     # Tree-local extensions:
-    'sphinxcontrib.towncrier',  # provides `towncrier-draft-entries` directive
+    'sphinxcontrib.towncrier.ext',  # provides `.. towncrier-draft-entries::`
 ]
 
 # Add any paths that contain templates here, relative to this directory.