[MRG] Documentation cleaning #63
Merged
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
| @@ -2,6 +2,10 @@ | |||
| # Author: Óscar Nájera | |||
| # License: 3-clause BSD | |||
| """ | |||
| ======================== | |||
| Backrefecences Generator | |||
Titan-C
force-pushed
the
referencesdoc
branch
from
5306527
to
12729a9
Compare
|
Use [MRG] in the header rather than review. The convention comes from scikit-learn. |
| module and their methods. Then within your sphinx documentation files you | ||
| The path you specify in ``mod_example_dir`` will get populated with | ||
| ReStructuredText files describing the examples thumbnails with links | ||
| to them but only for the specific module. Keep in mind is relavive to |
| Sphinx-Gallery also enables you, when documenting your modules, to reference | ||
| into examples that use that particular module. | ||
| Sphinx-Gallery also enables you, when documenting your modules, to | ||
| reference into the examples that use that particular class or |
There was a problem hiding this comment.
Not 100% sure, but maybe "reference the examples" rather than "reference into the examples".
There was a problem hiding this comment.
maybe is "reference to the examples"
|
You need to rebase on master after the sphinxgallery -> sphinx_gallery renaming |
ping @Titan-C. If you don't have too much time I can do it myself, let me know! |
Document modules with backreferences
Titan-C
force-pushed
the
referencesdoc
branch
from
1b1890d
to
15bca7e
Compare
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.
Documentation review for facilitating Gallery adoption