Added viewcode extension to sphinx to view source code in documentation [fixing #171] #184
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
|
found this issue with a solution readthedocs/readthedocs.org#2139 (comment) I would try to change this line https://github.com/ecignoni/equistore/blob/3c32cc78edbecaacb4a6103ce5ea53838d1cd144/docs/src/conf.py#L12 to sys.path.append(os.path.join(ROOT, "python", "src", "equistore"))EDIT: reflecting on this, we are already adding the src folder, so it should not be the fix. Also the problem is not that the link is missing, but that the doc is not shown |
|
Seems to work fine now! |
|
Looks good. Thanks for the nice fix! |
Merged
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.
fixing #171
📚 Documentation preview 📚: https://equistore--184.org.readthedocs.build/en/184/