You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When using sphinx-autodoc-typehints, text between single backticks in parameter descriptions gets rendered as <cite/> nodes, i.e. using docutils’ default title-reference role instead of the role we configured.
I don’t know exactly why, but removing s-a-t from the plugin list fixes this, and you’re e.g. using a plain RstParser() instance in several places which has that behavior. Maybe that parser replaces the role and doesn’t clean up properly after itself?
When using sphinx-autodoc-typehints, text between single backticks in parameter descriptions gets rendered as
<cite/>
nodes, i.e. using docutils’ defaulttitle-reference
role instead of the role we configured.I don’t know exactly why, but removing s-a-t from the plugin list fixes this, and you’re e.g. using a plain
RstParser()
instance in several places which has that behavior. Maybe that parser replaces the role and doesn’t clean up properly after itself?sphinx-autodoc-typehints/src/sphinx_autodoc_typehints/__init__.py
Line 799 in 0bec1bc
sphinx-autodoc-typehints/src/sphinx_autodoc_typehints/attributes_patch.py
Line 66 in 0bec1bc
Check out
sphinx.testing.restructuredtext:parse
for a parser setup that sets up all the Sphinx stuff.The text was updated successfully, but these errors were encountered: