Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: start reorg explain #25218

Closed
wants to merge 1 commit into from

Conversation

jklymak
Copy link
Member

@jklymak jklymak commented Feb 14, 2023

PR Summary

This PR builds on #25209 so won't have as many changed files upon rebase - only look at the second commit to see what this entails..

It sets up the conf.py to make /galleries/users_explain create /doc/users/explain using sphinx-gallery. There are no other changes, so this is a useless use of sphinx-gallery 😉, but the point is to show how this would look. After this, we can start re-organizing and using *.py gallery files interspersed with *.rst, and using our own index.rst at each level.

PR Checklist

Documentation and Tests

  • Has pytest style unit tests (and pytest passes)
  • Documentation is sphinx and numpydoc compliant (the docs should build 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 in doc/users/next_whats_new/
  • API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
  • Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

@jklymak jklymak force-pushed the doc-start-reorg-explain branch 3 times, most recently from 3c4acfe to a836ddb Compare February 14, 2023 20:52
@jklymak
Copy link
Member Author

jklymak commented Feb 14, 2023

@jklymak jklymak force-pushed the doc-start-reorg-explain branch from a5cf0c0 to 30fcf6d Compare February 24, 2023 01:57
@jklymak jklymak marked this pull request as ready for review February 24, 2023 04:55
@jklymak
Copy link
Member Author

jklymak commented Feb 24, 2023

.. obviously this should only go in if we are serious about combining *.rst and tutorial-style *.py files.

@jklymak
Copy link
Member Author

jklymak commented Mar 8, 2023

Closed in favour of #25395

@jklymak jklymak closed this Mar 8, 2023
@jklymak jklymak deleted the doc-start-reorg-explain branch March 8, 2023 23:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant