API doc tweaks [skip ci] - #1764
Open
gavinmacaulay wants to merge 2 commits into
Open
Conversation
- use automodule instead of automodapi - add documentation for colormap
Collaborator
|
note because I'm thinking of this now and I have a feeling it's related to this issue re API doc, but I'll dig in a bit later! #1690 |
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
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.
Changes in this PR:
These changes are a bit more opinionated than my earlier doc PRs, so I give some context:
I've always found the echopype API documentation hard to follow, mainly because there were two ways to access the individual class/function documentation - the long unsorted list of function/member names under the
API referencemenu in the left sidebar of the docs and the same stuff under various headings in the right sidebar with a confusingFunctionsentry under each heading.The changes in this PR remove the list of functions in the left sidebar and the
Functionsheadings in the right sidebar. To me, at least, this makes for cleaner API docs that are also easier to look through for the class/function documentation that one is after.I also noticed that the echopype-provided colormaps were only documented in the user guide part of the docs and not in the API part, so I added a colormap section with an enhanced docstring.
Using the Sphinx autodoc plugin instead of automodapi removes the etoc.toctree warning that is unavoidable when using automodapi with an external table of contents, so suppression of those warnings is also removed (resolves a comment in #1763). Automodapi is not actively developed compared to autodoc (see
Development statusin the readme), so not using it reduces potential future hassles.These sort of changes to the API docs are what I was planning to attempt during the 2026 WGFAST echopype hackathon but never managed to do 😄.