Skip to content

Commit

Permalink
Remove sphinx_autodoc_typehints (#1603)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
trevorbaca authored Jan 4, 2025
1 parent 6ff89b8 commit aa2d295
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 2 deletions.
1 change: 0 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
"sphinx.ext.intersphinx",
"sphinx.ext.todo",
"sphinx.ext.viewcode",
"sphinx_autodoc_typehints",
"uqbar.sphinx.api",
"uqbar.sphinx.book",
"uqbar.sphinx.inheritance",
Expand Down
1 change: 0 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ def get_abjad_version():
"pytest>=8.1.1",
"pytest-cov>=4.1.0",
"pytest-helpers-namespace>=2021.12.29",
"sphinx-autodoc-typehints>=1.22.0",
"sphinx-rtd-theme>=1.0.0",
],
}
Expand Down

0 comments on commit aa2d295

Please sign in to comment.