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

Docs: Clean module docs for predict module #267

Closed
JSchlensok opened this issue Sep 23, 2024 · 0 comments · Fixed by #302
Closed

Docs: Clean module docs for predict module #267

JSchlensok opened this issue Sep 23, 2024 · 0 comments · Fixed by #302
Labels
enhancement New feature or request

Comments

@JSchlensok
Copy link
Contributor

Is your feature request related to a problem? Please describe.

The predict module, unlike others, contains classes. When using autosummary and toctree like for other modules, the documentation generated by Sphinx for these classes is not as easy to navigate and not as complete as for methods.

Describe the solution you would like

Auto-generated list of module-level classes and methods in API.rst, ideally excluding methods not exposed in the API (excluded from __all__ in oktoberfest/predict/__init__.py) with links to detailed individual documentation pages.

@JSchlensok JSchlensok added the enhancement New feature or request label Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
1 participant