Slightly reorganize api docs. #19440
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
jklymak
previously requested changes
Feb 3, 2021
There was a problem hiding this comment.
Blocking just so that we sort out the moving/redirect process before this is merged. We will likely try to start using reredirects and this PR would need entries in the list of re-directs. https://gitlab.com/documatt/sphinx-reredirects/-/tree/master/
|
This has a real error? /home/circleci/project/doc/api/backend_wx_api.rst:12: WARNING: py:mod reference target not found: matplotlib.backends.backend_wxcairo |
- Move _enums to _enums_api, consistently with other modules, and
move it to the end (together with the other private module, _api).
- Group the various GUI backends together based on the GUI toolkit.
(It seems a bit silly to have so many pages which all refer to
backends with no generated docs anyways, and even if we could easily
generate docs for them on CI we would not want to document all 4
mostly indentical copies of qt{4,5}{agg,cairo} on 4 different pages.)
Also use `.. module::` entries to fix broken references.
|
hopefully better now... |
jklymak
approved these changes
Feb 5, 2021
|
How did you make the missing_references.json? |
|
|
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.
Move _enums to _enums_api, consistently with other modules, and
move it to the end (together with the other private module, _api).
Group the various GUI backends together based on the GUI toolkit.
(It seems a bit silly to have so many pages which all refer to
backends with no generated docs anyways, and even if we could easily
generate docs for them on CI we would not want to document all 4
mostly indentical copies of qt{4,5}{agg,cairo} on 4 different pages.)
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).