Autodocs #43
Labels
documentation
Improvements or additions to documentation
enhancement
New feature or request
good first issue
Good for newcomers
Context
Our rtd documentation does not have code docs. Since we use Google Python heredocs, we can support autodocumentation generation.
Is your feature request related to a problem? Please describe.
Right now the only way to see the interface to palm is to read the code directly :(
Describe the solution you'd like
Autodocs are built automatically from the code heredocs in our rtd documentation. Probably use Napoleon for compiling, and sensible settings (don't expose private methods, constants etc etc).
Describe alternatives you've considered
Manually building code docs.. why?
Additional context
We may also want a simple "cheat sheet" that is manually maintained and parsed from these. But real autodocs are huge.
Is there an existing feature request for this?
The text was updated successfully, but these errors were encountered: