DOC: add transformations doc to HTML & reorganize contents #5908
Conversation
This file contains 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
jakevdp
commented
Mar 3, 2021
jakevdp
force-pushed
the
transforms-doc
branch
2 times, most recently
from
23fbc42
to
82569c0
Compare
jakevdp
changed the title
8bitmp3
reviewed
Mar 3, 2021
jakevdp
force-pushed
the
transforms-doc
branch
2 times, most recently
from
6a47f91
to
8e7b405
Compare
mattjj
reviewed
Mar 9, 2021
mattjj
reviewed
Mar 9, 2021
mattjj
reviewed
Mar 9, 2021
This was referenced Mar 10, 2021
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.
This seems to fit better in the actual documentation, where the code can be doctested, which actually caught some existing mistakes.
This is a first-step toward making the github README a bit lighter and making the HTML docs a bit more organized and useful. As part of that, I re-organized our documentation to separate API docs from the advanced tutorials. I think some further reorganization based on this will be useful.