Rework headers for individual backend docs. #21188
Merged
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
5ec11c6 to
b313e46
Compare
QuLogic
reviewed
Sep 27, 2021
Previously, the first header would be used in the ToC/sidebar, resulting e.g. in a "matplotlib.backends.backend_gtk3agg" entry even though the page documents both backend_gtk3agg and backend_gtk3cairo. Instead, merge the titles, and also get rid of the common "matplotlib.backends" prefix (the individual API doc entries keep the fully qualified name anyways). Also fix the qt docs: the canonical version is now at qtagg/qtcairo, not qt5agg/qt5cairo.
b313e46 to
1a4bf4e
Compare
QuLogic
approved these changes
Sep 28, 2021
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Sep 28, 2021
QuLogic
added a commit
that referenced
this pull request
Sep 28, 2021
…188-on-v3.5.x Backport PR #21188 on branch v3.5.x (Rework headers for individual backend docs.)
tacaswell
pushed a commit
to tacaswell/matplotlib
that referenced
this pull request
Oct 12, 2021
Rework headers for individual backend docs.
tacaswell
pushed a commit
that referenced
this pull request
Oct 20, 2021
Rework headers for individual backend docs.
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.
Previously, the first header would be used in the ToC/sidebar, resulting
e.g. in a "matplotlib.backends.backend_gtk3agg" entry even though the
page documents both backend_gtk3agg and backend_gtk3cairo. Instead,
merge the titles, and also get rid of the common "matplotlib.backends"
prefix (the individual API doc entries keep the fully qualified name
anyways).
Also fix the qt docs: the canonical version is now at qtagg/qtcairo, not
qt5agg/qt5cairo.
PR Summary
PR Checklist
pytestpasses).flake8on changed files to check).flake8-docstringsand runflake8 --docstring-convention=all).doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).