DOC: move arranging axes tutorial to users #24979
Closed
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
This is a test to see how easy it is to move a tutorial into the users docs, making it a native rst file instead of using sphinx-gallery. Turns out its pretty easy, with a couple of important caveats...
All that was done here was to run sphinx gallery on
/tutorials/intermediate/arranging_axes.py
and then hand-edited thearranging_axes.rst
to replace.. code-block:: default
withand then remove the
.. image-sg ::
directives.Note, that I'm not arguing we should get rid of sphinx gallery. However, many of the explanatory tutorials should probably be logically be under
/users
. This is just a proof of concept to see what such a migration would look likePR 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