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

Put long param sections in dropdowns #527

Open
JWCook opened this issue Dec 11, 2023 · 0 comments
Open

Put long param sections in dropdowns #527

JWCook opened this issue Dec 11, 2023 · 0 comments
Labels
docs Documentation-related issues
Milestone

Comments

@JWCook
Copy link
Member

JWCook commented Dec 11, 2023

In docs for functions with tons of request parameters (mostly the observation endpoints), these param lists take up most of the space in the doc page. Example: https://pyinaturalist.readthedocs.io/en/stable/modules/pyinaturalist.v1.observations.html

It would be nice to put these under dropdown boxes (collapsed by default). Since these param lists are generated by sphinx-autodoc and sphinx-autodoc-typehints, though, I'm not quite sure how to do that.

@JWCook JWCook added the docs Documentation-related issues label Dec 11, 2023
@JWCook JWCook added this to the v1.0 milestone Dec 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation-related issues
Projects
None yet
Development

No branches or pull requests

1 participant