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
[ ] 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)
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