Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
DOC: fix Sphinx Gallery discussion to explain mixed subddirs#25618
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
jklymak commentedApr 5, 2023 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
|
8994247
to0539533
Comparedoc/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. |
melissawmApr 13, 2023 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
There may be a sentence part missing here? sorry my english has failed me here 😄 but I guess we should have "from havinga plot generated"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
OK, modified to be a little more clear (I hope)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
This looks great to me!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
This will need a rebase to fix CircleCI.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
0879780
tod92ab0b
Compare
Uh oh!
There was an error while loading.Please reload this page.
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
pytest
passes)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.rst
ornext_api_changes/README.rst