Skip to content

Conversation

@FedericoNegri
Copy link
Contributor

@FedericoNegri FedericoNegri commented Feb 11, 2024

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:

  1. The auto generated api includes subpackages/modules that are of little use for the users. These for instances
    image
  2. Doc of pydantic models doesn't look nice, example:
    image
    vs using autodoc_pydantic
    image
  3. Sphinx produces tons of GL08 warnings about missing docstrings of pydantic models. Sources also still contain the old rst files for api doc, which are unused by now.

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
image

Link to latest html artifact

@RobPasMue @klmcadams what do you think?

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 11, 2024
@RobPasMue
Copy link
Member

Looks good for me @FedericoNegri - we just wanted to reduce the maintainability of the docs by using sphinx-autoapi since it generates automatically everything for you and your API docs never go out of sync due to missing documented classes, methods etc. If you prefer this approach, by all means, go for it :)

@FedericoNegri FedericoNegri marked this pull request as ready for review February 12, 2024 09:30
@github-actions github-actions bot added dependencies Related with project dependencies maintenance Package and maintenance related labels Feb 12, 2024
@FedericoNegri FedericoNegri merged commit 88d89be into main Feb 12, 2024
@FedericoNegri FedericoNegri deleted the fnegri/rework_api_ref branch February 12, 2024 10:47
@klmcadams klmcadams mentioned this pull request Feb 12, 2024
5 tasks
@FedericoNegri FedericoNegri linked an issue Feb 21, 2024 that may be closed by this pull request
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Related with project dependencies documentation Improvements or additions to documentation maintenance Package and maintenance related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Follow ups to first doc edit for public release

3 participants