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

Replace functions / classes with links to source documentation #160

Open
adrn opened this issue Sep 28, 2017 · 0 comments
Open

Replace functions / classes with links to source documentation #160

adrn opened this issue Sep 28, 2017 · 0 comments

Comments

@adrn
Copy link
Member

adrn commented Sep 28, 2017

This is only relevant once #153 is merged

sphinx-gallery has a nice feature in which it auto-identifies function and class names from intersphinx-ed packages and replaces the rendered html versions of the names with links to the source documentation. For example: check out the last code block on this page.

We might be able to use the sphinx-gallery machinery to (hackily) do this to our own rendered notebooks as a postprocessing step during the sphinx build. This would likely require modifying nbsphinx to support specifying a custom nbconvert postprocessor class (that we'd have to write).

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

No branches or pull requests

1 participant