Skip to content

Commit ffc5820

Browse files
authored
feat!: Remove sphinx_toctree_autodoc_fix (Superseded by sphinx 5.2+, #14)
- sphinx-doc/sphinx#6316 - sphinx-doc/sphinx#10807 - https://gist.github.com/agoose77/e8f0f8f7d7133e73483ca5c2dd7b907f
2 parents bd10fba + 63513d7 commit ffc5820

File tree

5 files changed

+20
-129
lines changed

5 files changed

+20
-129
lines changed

CHANGES

+20
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,26 @@ $ pip install --user --upgrade --pre gp-libs
2424

2525
- doctest_docutils: :mod:`doctest` w/ docutils support (and markdown)
2626

27+
### Removed features
28+
29+
- `sphinx_toctree_autodoc_fix` was removed in v0.0.1a12
30+
31+
Overcome by [Sphinx 5.2](https://pypi.org/project/Sphinx/5.2.0) bakes this in by default:
32+
33+
Settings options:
34+
35+
- `add_function_parentheses = False` (default: `True`)
36+
- `toc_object_entries_show_parents` can be (default: `'domain'`):
37+
- `toc_object_entries_show_parents = 'domain'`
38+
- `toc_object_entries_show_parents = 'hide'`
39+
- `toc_object_entries_show_parents = 'all'`
40+
41+
See also:
42+
43+
- https://github.com/sphinx-doc/sphinx/issues/6316
44+
- https://github.com/sphinx-doc/sphinx/pull/10807
45+
- https://gist.github.com/agoose77/e8f0f8f7d7133e73483ca5c2dd7b907f
46+
2747
### Documentation
2848

2949
- Initial docs, packaging, etc.

README.md

-18
Original file line numberDiff line numberDiff line change
@@ -132,24 +132,6 @@ In your _conf.py_:
132132

133133
See more: <https://gp-libs.git-pull.com/linkify_issues/>
134134

135-
### Table of contents for autodoc
136-
137-
`sphinx.ext.autodoc` doesn't link objects in the table of contents. So we need a
138-
plugin to help.
139-
140-
See more: <https://gp-libs.git-pull.com/sphinx_toctree_autodoc_fix/>
141-
142-
#### Configuration
143-
144-
1. Add `'sphinx_toctree_autodoc_fix'` to `extensions`
145-
146-
```python
147-
extensions = [
148-
# ...
149-
"sphinx_toctree_autodoc_fix",
150-
]
151-
```
152-
153135
## Install
154136

155137
```console

docs/index.md

-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
1010
quickstart
1111
doctest/index
12-
sphinx_toctree_autodoc_fix/index
1312
linkify_issues/index
1413
```
1514

docs/sphinx_toctree_autodoc_fix/index.md

-31
This file was deleted.

tests/test_sphinx_toctree_autodoc_fix.py

-79
This file was deleted.

0 commit comments

Comments
 (0)