From 56da7c05bd50e399da3475da96adbe399556eb62 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Trevor=20Ba=C4=8Da?= Date: Sat, 4 Jan 2025 15:51:44 -0500 Subject: [PATCH] Remove sphinx_autodoc_typehints sphinx_autodoc_typehints has had some long-running bugs related to the reST `container` directive. The current bug is ... https://github.com/tox-dev/sphinx-autodoc-typehints/issues/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. --- docs/source/conf.py | 1 - setup.py | 1 - 2 files changed, 2 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index ab396e14c5..16295bf0cc 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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", diff --git a/setup.py b/setup.py index f027347838..e45af3db3e 100644 --- a/setup.py +++ b/setup.py @@ -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", ], }