Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc/cross reference #791

Merged
merged 9 commits into from
Aug 6, 2024
Merged

Doc/cross reference #791

merged 9 commits into from
Aug 6, 2024

Conversation

timsaucer
Copy link
Contributor

@timsaucer timsaucer commented Jul 28, 2024

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:
Screenshot 2024-07-29 at 6 36 56 AM

And here is the updated view:
Screenshot 2024-07-29 at 6 33 32 AM

The four points of interest highlighted are:

  1. On the navigation bar on the left, now the entire API is exposed. This does come at the cost of no longer pointing out only the most important sections of the interface.
  2. Cross linking works from docstrings to the online user documents. That is, you can now cross link from a docstring to a portion of the online manual without a hyperlink required. This helps prevent breaking if the paths change in the online docs.
  3. Cross linking now works from one docstring to another class, function, module, etc.
  4. The right hand side bar is a little different. I also played around with changing the depth of this but it did get very busy. That might be helpful for easy navigation though.

@timsaucer timsaucer marked this pull request as draft July 28, 2024 18:11
@timsaucer timsaucer marked this pull request as ready for review July 29, 2024 12:13
@timsaucer timsaucer mentioned this pull request Jul 29, 2024
10 tasks
Copy link
Contributor

@Michael-J-Ward Michael-J-Ward left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#795 fixes the missing export tests, right?

Maybe just include that commit in this PR?

Otherwise, LGTM

@andygrove andygrove merged commit bd0e820 into apache:main Aug 6, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants