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

Auto-generated documentation website for SDK API #420

Open
3 tasks
EarthenSky opened this issue May 7, 2024 · 0 comments
Open
3 tasks

Auto-generated documentation website for SDK API #420

EarthenSky opened this issue May 7, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation priority/P3

Comments

@EarthenSky
Copy link
Contributor

Most python libraries host websites dedicated for documentation, notably including autogenerated API References. The html for these API References is generated using off the shelf libraries that read python doc comments and typing hints. An arbitrary example of a library that does that is bigfloat.

It would be helpful for new users if they had a documentation like this they could reference, instead of having to look through source code. The User Guides under each module work as initial versions of a documentation site (example for thermocoupler), and we would want to include them as pages in the documentation site.

Creating an API Reference like this would take several steps, including

  • ensuring all public API functions and classes are documented with doc comments
  • deciding on a tool to use (see this list of python docs tools)
  • figuring out how to get the api reference to auto build & deploy with each release (some info about setting up readthedocs, but there are other alternatives)
@EarthenSky EarthenSky added the documentation Improvements or additions to documentation label May 7, 2024
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 priority/P3
Projects
None yet
Development

No branches or pull requests

2 participants