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

Divide API documentation #688

Merged
merged 2 commits into from
Jan 12, 2024

Conversation

MaanasArora
Copy link
Contributor

Addresses issue #479.

I divided api.rst into one file for each section and referenced them individually from index.rst.

Thank you!

@fabianp
Copy link
Member

fabianp commented Jan 4, 2024

Thanks @MaanasArora ! This is great.

Just one minor comment:

For some reason the contrib module appears different than the rest (module members appear in the left hand side while in the others they don't). Can we make the contrib module appear the same as the others?

image

@MaanasArora
Copy link
Contributor Author

Hi @fabianp thanks for the review!

It seems that the source of the Contrib subtree was a toctree directive that generated stub for each autosummary, so I removed the nested toctrees. Let me know if this change is okay, thank you!

Copy link
Member

@fabianp fabianp left a comment

Choose a reason for hiding this comment

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

Excellent, thanks! This looks good to me.

@MaanasArora
Copy link
Contributor Author

Thank you! Let me know if I need to do anything else for this to be merged.

@fabianp
Copy link
Member

fabianp commented Jan 7, 2024

Its now waiting for internal review. Should be done early next week. Thanks again for the contribution!

@MaanasArora
Copy link
Contributor Author

Got it, thanks a lot!

@copybara-service copybara-service bot merged commit 9c7519a into google-deepmind:master Jan 12, 2024
6 checks passed
@amosyou amosyou mentioned this pull request Jan 19, 2024
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.

None yet

2 participants