sphinx-contrib / napoleon

Other
148 stars 48 forks source link

Type aliases not linked correctly with napoleon #28

Open abaisero opened 3 years ago

abaisero commented 3 years ago

Hi,

I cannot get type aliases referenced in the docstring to be linked with napoleon. Find attached a minimal working example, where I try to use napoleon to document package.sphinx_example.func. Sphinx's autodoc extension handles extensions via an autodoc_type_aliases variable in conf.py. You'll notice that the type aliases in the function signature are named and linked correctly. Is there a way of obtaining the correct links in the docstring with napoleon?

sphinx_example.zip