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.

Sign up for GitHub

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

Jump to bottom

Break the API documentation into subpages #676

Closed
fabianp opened this issue Dec 18, 2023 · 3 comments
Closed

Break the API documentation into subpages #676

fabianp opened this issue Dec 18, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@fabianp
Copy link
Member

fabianp commented Dec 18, 2023

Currently https://optax.readthedocs.io/en/latest/api.html is very long and difficult to navigate.

It could probably be improved by splitting it into several subpages and have the different sections appear in the left hand side.
@fabianp fabianp added documentation Improvements or additions to documentation good first issue Good for newcomers labels Dec 18, 2023
@mtthss
Copy link
Collaborator

mtthss commented Dec 18, 2023

+1

@Bigpet
Copy link
Contributor

Bigpet commented Jan 13, 2024 •
edited
Loading

seems to have been done by #688

looks like this can be closed

@fabianp
Copy link
Member Author

fabianp commented Jan 14, 2024

indeed, thanks!

@fabianp fabianp closed this as completed Jan 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@fabianp @Bigpet @mtthss