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

docs: add sphinx extension that auto-links to source code #225

Merged
merged 1 commit into from
Sep 3, 2021

Conversation

mhasself
Copy link
Member

@mhasself mhasself commented Sep 3, 2021

As discussed. This is a good thing.

@BrianJKoopman BrianJKoopman merged commit 137ccdd into develop Sep 3, 2021
@BrianJKoopman BrianJKoopman deleted the sphinx-ext-viewcode branch September 3, 2021 06:00
@jlashner
Copy link
Collaborator

jlashner commented Sep 7, 2021

Does this automatically link to code from autodoc? Or is there something we need to add in the rst?

Just checked the ocs read the docs and can't find the links, but I don't really know where to look.

@BrianJKoopman
Copy link
Member

Next to autoclass or automethod class/method names there's a green [source]. That links not to the github repo, but to a sphinx page that shows the source file. For instance on the API page:
image

@jlashner
Copy link
Collaborator

jlashner commented Sep 7, 2021

Ah got it, was looking at the "latest" build and not develop

@BrianJKoopman BrianJKoopman mentioned this pull request Nov 29, 2021
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

Successfully merging this pull request may close these issues.

3 participants