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

[Feature Request] Add all classes to the Docs #193

Open
gwwatkin opened this issue Dec 19, 2021 · 1 comment
Open

[Feature Request] Add all classes to the Docs #193

gwwatkin opened this issue Dec 19, 2021 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@gwwatkin
Copy link
Member

Issue Description

We want all classes to be visible in the Sphinx API Docs on Read The Docs.

Proposed Solution

@alexnguyenn suggests adding manually to the docs/source folder. Then every PR needs to add the docs for the class they are adding.

Another option could be to add everything as auto generated.

@gwwatkin gwwatkin added the enhancement New feature or request label Dec 19, 2021
@alexnguyenn
Copy link
Member

Right now I prefer adding them manually using autodoc. Configuring the Sphinx's auto generating option will take a lot of time and it's not something I am keen on doing right now.

@gwwatkin gwwatkin added the documentation Improvements or additions to documentation label Dec 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants