Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
Slightly reorganize api docs.#19440
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
Uh oh!
There was an error while loading.Please reload this page.
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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... |
How did you make the missing_references.json? |
|
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).