Remove sphinx_autodoc_typehints #1603
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sphinx_autodoc_typehints has had some long-running bugs related
to the reST `container` directive.
The current bug is ...
tox-dev/sphinx-autodoc-typehints#513
... which mangles the formatting of docstrings that have a return-type
annotation and a `container` directive.
This commit removes sphinx_autodoc_typethints. This prevents
several dozen errors and warnings when Sphinx builds.
The extension doesn't look like it was providing much value to the docs
anyway. Sphinx adds type annotations without sphinx_autodoc_typehints.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
sphinx_autodoc_typehintshas had some long-running bugs related to the reSTcontainerdirective.The current bug is ...
... which mangles the formatting of docstrings that have a return-type annotation and a
containerdirective.This commit removes sphinx_autodoc_typethints. This prevents several dozen errors and warnings when Sphinx builds.
The extension doesn't look like it was providing much value to the docs anyway. Sphinx adds type annotations without
sphinx_autodoc_typehints.