Conversation
…switch from autosummary to autoapi in sphinx for building API reference documents
169cc36 to
611c2d9
Compare
Michael-J-Ward
approved these changes
Aug 5, 2024
Contributor
Michael-J-Ward
left a comment
There was a problem hiding this comment.
#795 fixes the missing export tests, right?
Maybe just include that commit in this PR?
Otherwise, LGTM
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.
Which issue does this PR close?
No existing issue but a follow on to #750
Rationale for this change
This is almost entirely a documentation update. It allows us to expose all the python APIs on the documentation site. Additionally the cross linking is fixed so that docstrings can link to other functions and classes.
What changes are included in this PR?
Switch from autodoc and autosummary to autoapi.
Change docstring and document rst files to use the generated references.
Are there any user-facing changes?
Updated site documentation, but APIs themselves are not impacted.
Here is a screenshot of documentation site built locally without this PR:

And here is the updated view:

The four points of interest highlighted are: