Update autodoc config and get linkcode working with jupyterbook #109
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Of course readthedocs will end up being a totally different story... |
|
There we go. Also, it looks like |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since jupyter book doesn't support dynamic configuration, there's not a simple way to provide a function for the
linkcodeextension.Instead we use this suggestion jupyter-book/jupyter-book#1673 (comment) and create a passthrough local sphinx extension which just uses linkcode's normal setup, but we add our
linkcode_resolvefunction to the config just before calling setup.This sidesteps the problem and doesn't end up being too bad.