DOC: fix Sphinx Gallery discussion to explain mixed subddirs #25618
+46
−11
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
|
|
8994247 to
0539533
Compare
melissawm
reviewed
Apr 13, 2023
doc/devel/documenting_mpl.rst
Outdated
| The first three are traditional galleries, :file:`galleries/users_explain` is a | ||
| mixed gallery where some of the files are raw ``*.rst`` files rather than | ||
| ``*.py`` files; Sphinx Gallery just copies those from the location to the build | ||
| location (see :ref:`raw_restructured_gallery`, below). To exclude an example | ||
| from having an plot generated insert "sgskip" somewhere in the filename. |
There was a problem hiding this comment.
There may be a sentence part missing here? sorry my english has failed me here 😄 but I guess we should have "from having a plot generated"
There was a problem hiding this comment.
Maybe it's correct English, but I agree it's not very easy to parse. I'll take another swing at it.
There was a problem hiding this comment.
OK, modified to be a little more clear (I hope)
QuLogic
approved these changes
Apr 15, 2023
Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
0879780 to
d92ab0b
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.
PR Summary
Update the "Writing documentation" for the changes from #25395 to point out the possibility of galleries with *.py and *.rst files in them (with links to the SG documentation about this).
Also added a table of galleries with their sources and where they end up in the build.
PR Checklist
Documentation and Tests
pytestpasses)Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst