Improved Documentation #49
ThresaKelly
announced in
Announcements
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Description
Version v1.1.1 includes several improvements to the code documentation. All Python modules, classes, and functions now have Google-style docstrings, which provide relevant information. We use Sphinx to automatically generate documentation from these docstrings. The html pages are hosted on Read the Docs website: python-pod-api.readthedocs.io. The website has different pages for each API Module. You can also search the documentation using keywords. The code documentation can also be viewed in Python POD API Manual here.
Update Summary
This discussion was created from the release Improved Documentation.
Beta Was this translation helpful? Give feedback.
All reactions