refactor!(toc): Rename to sphinx_toctree_autodoc_fix

Author: tony

README.md

@@ -125,16 +125,16 @@ See more: <https://gp-libs.git-pull.com/linkify_issues/>
 `sphinx.ext.autodoc` doesn't link objects in the table of contents. So we need a
 plugin to help.
 
-See more: <https://gp-libs.git-pull.com/sphinx_toctree_signature/>
+See more: <https://gp-libs.git-pull.com/sphinx_toctree_autodoc_fix/>
 
 #### Configuration
 
-1. Add `'sphinx_toctree_signature'` to `extensions`
+1. Add `'sphinx_toctree_autodoc_fix'` to `extensions`
 
    ```python
    extensions = [
        # ...
-       "sphinx_toctree_signature",
+       "sphinx_toctree_autodoc_fix",
    ]
    ```
 

docs/conf.py

@@ -6,9 +6,10 @@
 from os.path import dirname, relpath
 from pathlib import Path
 
+import sphinx_toctree_autodoc_fix
+
 import gp_libs
 import linkify_issues
-import sphinx_toctree_signature
 
 # Get the project root dir, which is the parent dir of this
 cwd = Path(__file__).parent
@@ -35,7 +36,7 @@
     "sphinxext.rediraffe",
     "myst_parser",
     "linkify_issues",
-    "sphinx_toctree_signature",
+    "sphinx_toctree_autodoc_fix",
 ]
 myst_enable_extensions = ["colon_fence", "substitution", "replacements"]
 

docs/index.md

@@ -9,7 +9,7 @@
 
 quickstart
 doctest/index
-sphinx_toctree_signature/index
+sphinx_toctree_autodoc_fix/index
 linkify_issues/index
 ```
 

docs/sphinx_toctree_signature/index.md renamed to docs/sphinx_toctree_autodoc_fix/index.md

@@ -1,4 +1,4 @@
-(sphinx_toctree_signature)=
+(sphinx_toctree_autodoc_fix)=
 (sphinx-toctree-signature)=
 
 # ToC + `sphinx.ext.autodoc` fixer
@@ -12,19 +12,19 @@ Table of Contents won't generate for `sphinx.ext.autodoc`, see
 
 In your _conf.py_:
 
-1. Add `'sphinx_toctree_signature'` to `extensions`
+1. Add `'sphinx_toctree_autodoc_fix'` to `extensions`
 
    ```python
    extensions = [
        # ...
-       "sphinx_toctree_signature",
+       "sphinx_toctree_autodoc_fix",
    ]
    ```
 
 ## API
 
 ```{eval-rst}
-.. automodule:: sphinx_toctree_signature
+.. automodule:: sphinx_toctree_autodoc_fix
    :members:
    :show-inheritance:
    :undoc-members:

src/sphinx_toctree_signature.py renamed to src/sphinx_toctree_autodoc_fix.py

@@ -51,14 +51,14 @@ def test_toc_shows_api_docs(
     test_id: str,
     text: str,
 ) -> None:
-    """Assert sphinx_toctree_signature collects entries from autodoc.
+    """Assert sphinx_toctree_autodoc_fix collects entries from autodoc.
 
     Normal sphinx ToC does not collect them< see sphinx-doc#6316
     """
     args, kwargs = make_app_params(
         index=text,
         confoverrides={
-            "extensions": ["sphinx_toctree_signature", "sphinx.ext.autodoc"],
+            "extensions": ["sphinx_toctree_autodoc_fix", "sphinx.ext.autodoc"],
             "html_theme": "basic",
         },
     )