Rework Doc API Reference #321
Merged
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.
During the technical review, the api reference section in the doc has been reworked to use sphinx-autoapi.
The resulting doc doesn't look great to me. Main issues:
vs using autodoc_pydantic
I'd prefer going back to the previous approach of a more handcrafted api reference, only including what really makes sense for a user to browse in a doc. Otherwise, they're just better off opening the sources.
Something I liked more of the autoapi one is the summary tables, so I'm using more of autosummary to get these tables

Link to latest html artifact
@RobPasMue @klmcadams what do you think?