attempt to make cross links between examples and API work #3344
Conversation
This file contains hidden or 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
Member
|
yeah, this would be a nice add on! |
| # generate empty examples files, so that we don't get | ||
| # inclusion errors if there are no examples for a class / module | ||
| examples_path = os.path.join(app.srcdir, "modules", "generated", | ||
| "%s.examples" % name) |
Contributor
There was a problem hiding this comment.
Should this be just os.path.join(app.srcdir, "generated", "%s.examples" % name)? It seems to fail on circle.
Member
Author
There was a problem hiding this comment.
I just copy pasted from nilearn.
please take over when you have time.
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
eg see for example:
http://nilearn.github.io/modules/generated/nilearn.image.high_variance_confounds.html
at bottom of the page. In our function.rst we have
.. include:: {{module}}.{{objname}}.examples
so to me it should work.
@jaeilepp can you have a look?