Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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

Merged
QuLogic merged 1 commit intomatplotlib:mainfromjklymak:doc-describe-mixed-sg
Apr 17, 2023

Conversation

jklymak
Copy link
Member

@jklymakjklymak commentedApr 4, 2023
edited
Loading

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

  • Has pytest style unit tests (andpytest passes)
  • Documentation is sphinx and numpydoc compliant (the docs shouldbuild without error).
  • New plotting related features are documented with examples.

Release Notes

  • New features are marked with a.. versionadded:: directive in the docstring and documented indoc/users/next_whats_new/
  • API changes are marked with a.. versionchanged:: directive in the docstring and documented indoc/api/next_api_changes/
  • Release notes conform with instructions innext_whats_new/README.rst ornext_api_changes/README.rst

@jklymakjklymak marked this pull request as draftApril 5, 2023 04:26
@jklymak
Copy link
MemberAuthor

jklymak commentedApr 5, 2023
edited
Loading

@jklymakjklymakforce-pushed thedoc-describe-mixed-sg branch 3 times, most recently from8994247 to0539533CompareApril 5, 2023 21:09
@jklymakjklymak marked this pull request as ready for reviewApril 5, 2023 22:08
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.
Copy link
Member

@melissawmmelissawmApr 13, 2023
edited
Loading

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"

Copy link
MemberAuthor

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.

Copy link
MemberAuthor

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)

Copy link
Member

@melissawmmelissawm left a 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!

Copy link
Member

@QuLogicQuLogic left a 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.

Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
@jklymakjklymakforce-pushed thedoc-describe-mixed-sg branch from0879780 tod92ab0bCompareApril 15, 2023 15:20
@jklymakjklymak added this to thev3.8.0 milestoneApr 17, 2023
@QuLogicQuLogic merged commit4aa5ac7 intomatplotlib:mainApr 17, 2023
@jklymakjklymak deleted the doc-describe-mixed-sg branchApril 17, 2023 23:55
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@melissawmmelissawmmelissawm left review comments

@QuLogicQuLogicQuLogic approved these changes

Assignees
No one assigned
Projects
None yet
Milestone
v3.8.0
Development

Successfully merging this pull request may close these issues.

3 participants
@jklymak@QuLogic@melissawm

[8]ページ先頭

©2009-2025 Movatter.jp