Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Sep 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 20 additions & 0 deletions CHANGES
Original file line number Diff line number Diff line change
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
Original file line number Diff line number Diff line change
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
Original file line number Diff line number Diff line change
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.