Reorder API docs: separate file per module #12727
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
tacaswell
approved these changes
Nov 4, 2018
|
I would rather we not backport the documenation overhaul to the bug-fix branches, but open to being convinced otherwise. I am 👍 on this. |
|
I don't care too much about backporting here. I expect there's just 3.0.2 before 3.1.0 in a couple of months, so it doesn't make a big difference. OTOH, as long as the changes are limited to |
|
The index is here: https://15719-1385122-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/api/index.html Looks good to me. |
jklymak
approved these changes
Nov 5, 2018
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.
PR Summary
This is a start for reorganizing the API docs.
The current API docs are a mixture of plain API and additional description (e.g. https://matplotlib.org/devdocs/api/animation_api.html). The goal is to ultimately separate these.
Scope of this PR
In a first step, this PR unifies the structure of the
*_api.rstfiles so that each module has its own file. In particular:[mymodule]_api.rstfor each matplotlib module.matplotlib.mymodule.Not in this PR
This PR does not modify the way individual modules are documented; i.e. the contents of
[mymodule]_api.rstremains as is except from changes of section titles and separating modules. This will be handled later on in a separate PR.There may be changes in how we generate the API docs in the future (#11727). Either way, a clear structure is a helpful step to clean up the API docs. In that sense, this PR should be seen as an incremental improvement.