feat!: Remove sphinx_toctree_autodoc_fix (Superseded by sphinx 5.2+)

- sphinx-doc/sphinx#6316 - sphinx-doc/sphinx#10807 - https://gist.github.com/agoose77/e8f0f8f7d7133e73483ca5c2dd7b907f
git-pull · Sep 24, 2022 · 5e1fdd5 · 5e1fdd5
1 parent d8ff8cd
commit 5e1fdd5
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 123 deletions.
diff --git a/README.md b/README.md
@@ -134,21 +134,23 @@ See more: <https://gp-libs.git-pull.com/linkify_issues/>
 
 ### Table of contents for autodoc
 
-`sphinx.ext.autodoc` doesn't link objects in the table of contents. So we need a
-plugin to help.
+Removed in v0.0.1a12.
 
-See more: <https://gp-libs.git-pull.com/sphinx_toctree_autodoc_fix/>
+[Sphinx 5.2](https://pypi.org/project/Sphinx/5.2.0) bakes this in by default:
 
-#### Configuration
+Settings options:
 
-1. Add `'sphinx_toctree_autodoc_fix'` to `extensions`
+- `add_function_parentheses = False` (default: `True`)
+- `toc_object_entries_show_parents` can be (default: `'domain'`):
+  - `toc_object_entries_show_parents = 'domain'`
+  - `toc_object_entries_show_parents = 'hide'`
+  - `toc_object_entries_show_parents = 'all'`
 
-   ```python
-   extensions = [
-       # ...
-       "sphinx_toctree_autodoc_fix",
-   ]
-   ```
+See also:
+
+- https://github.com/sphinx-doc/sphinx/issues/6316
+- https://github.com/sphinx-doc/sphinx/pull/10807
+- https://gist.github.com/agoose77/e8f0f8f7d7133e73483ca5c2dd7b907f
 
 ## Install
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -35,7 +35,6 @@
     "sphinxext.rediraffe",
     "myst_parser",
     "linkify_issues",
-    "sphinx_toctree_autodoc_fix",
 ]
 myst_enable_extensions = [
     "colon_fence",
@@ -94,6 +93,9 @@
     ]
 }
 
+# sphinx.ext.autoapi
+toc_object_entries_show_parents = "hide"
+
 # linkify_issues
 issue_url_tpl = f'{about["__github__"]}/issues/{{issue_id}}'
 

diff --git a/docs/index.md b/docs/index.md
@@ -9,7 +9,6 @@
 
 quickstart
 doctest/index
-sphinx_toctree_autodoc_fix/index
 linkify_issues/index
 ```
 

diff --git a/docs/sphinx_toctree_autodoc_fix/index.md b/docs/sphinx_toctree_autodoc_fix/index.md
diff --git a/tests/test_sphinx_toctree_autodoc_fix.py b/tests/test_sphinx_toctree_autodoc_fix.py