Skip to content

Commit

Permalink
feat!: Remove sphinx_toctree_autodoc_fix (Superseded by sphinx 5.2+,
Browse files Browse the repository at this point in the history
  • Loading branch information
tony committed Sep 24, 2022
2 parents bd10fba + 63513d7 commit ffc5820
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 129 deletions.
20 changes: 20 additions & 0 deletions CHANGES
Expand Up @@ -24,6 +24,26 @@ $ pip install --user --upgrade --pre gp-libs

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

### Removed features

- `sphinx_toctree_autodoc_fix` was removed in v0.0.1a12

Overcome by [Sphinx 5.2](https://pypi.org/project/Sphinx/5.2.0) bakes this in by default:

Settings options:

- `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'`

See also:

- https://github.com/sphinx-doc/sphinx/issues/6316
- https://github.com/sphinx-doc/sphinx/pull/10807
- https://gist.github.com/agoose77/e8f0f8f7d7133e73483ca5c2dd7b907f

### Documentation

- Initial docs, packaging, etc.
Expand Down
18 changes: 0 additions & 18 deletions README.md
Expand Up @@ -132,24 +132,6 @@ In your _conf.py_:

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.

See more: <https://gp-libs.git-pull.com/sphinx_toctree_autodoc_fix/>

#### Configuration

1. Add `'sphinx_toctree_autodoc_fix'` to `extensions`

```python
extensions = [
# ...
"sphinx_toctree_autodoc_fix",
]
```

## Install

```console
Expand Down
1 change: 0 additions & 1 deletion docs/index.md
Expand Up @@ -9,7 +9,6 @@
quickstart
doctest/index
sphinx_toctree_autodoc_fix/index
linkify_issues/index
```

Expand Down
31 changes: 0 additions & 31 deletions docs/sphinx_toctree_autodoc_fix/index.md

This file was deleted.

79 changes: 0 additions & 79 deletions tests/test_sphinx_toctree_autodoc_fix.py

This file was deleted.

0 comments on commit ffc5820

Please sign in to comment.