Skip to content

Commit ea99998

Browse files
jhamonclaude
andcommitted
fix(docs): remove sphinx-autodoc-typehints to fix CI build failure
The extension injects :rtype: fields after the Examples section, causing docutils to emit an "unexpected unindent" warning for methods with Iterator return types + code-block examples (e.g. GrpcIndex.list). sphinx.ext.autodoc's built-in autodoc_typehints="description" support covers the same use case without the conflict. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
1 parent 3668c47 commit ea99998

2 files changed

Lines changed: 0 additions & 2 deletions

File tree

docs/conf.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616
"sphinx.ext.intersphinx",
1717
"sphinx.ext.doctest",
1818
"sphinx.ext.coverage",
19-
"sphinx_autodoc_typehints",
2019
"sphinx_copybutton",
2120
"sphinx_tabs.tabs",
2221
"myst_parser",

pyproject.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ docs = [
5252
"sphinx>=8.0",
5353
"furo",
5454
"myst-parser>=4.0",
55-
"sphinx-autodoc-typehints>=2.0",
5655
"sphinx-copybutton",
5756
"sphinx-tabs",
5857
]

0 commit comments

Comments
 (0)