Skip to content
This repository has been archived by the owner on Apr 26, 2023. It is now read-only.

Type aliases not linked correctly with napoleon #28

Open
abaisero opened this issue Dec 20, 2020 · 0 comments
Open

Type aliases not linked correctly with napoleon #28

abaisero opened this issue Dec 20, 2020 · 0 comments

Comments

@abaisero
Copy link

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant