Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sphinx.ext.viewcode not working ? #212

Closed
Cdebus opened this issue Jun 3, 2020 · 2 comments
Closed

sphinx.ext.viewcode not working ? #212

Cdebus opened this issue Jun 3, 2020 · 2 comments

Comments

@Cdebus
Copy link

Cdebus commented Jun 3, 2020

For our project documentation we would like to show [Source] links next to the API references. In principle sphinx.ext.viewcode should be able to provide this, however it doesn't seem to be working so far neither on my local build nor on the readthedocs build. From the references to sphinx.ext.viewcode I have found so far, none is using sphinx-autoapi, they all rely on autodoc (e.g. readthedocs/readthedocs.org#2139).

Anyone with some experience on this topic?

@AWhetter
Copy link
Collaborator

AWhetter commented Jun 4, 2020

Hi @Cdebus. If this isn't a problem with AutoAPI then https://github.com/readthedocs/readthedocs.org/issues seems like the right place to raise the issue rather than here.

@AWhetter AWhetter closed this as completed Jun 4, 2020
@markusritschel
Copy link

Just because I stumbled upon the same problem. The solution that worked for me is mentioned here
and is basically that 'sphinx_autodoc_typehints' needs to be added after 'sphinx.ext.napoleon'.

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

No branches or pull requests

3 participants