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

Autodocs #43

Open
1 task done
ethanknox-palmetto opened this issue Dec 2, 2021 · 1 comment
Open
1 task done

Autodocs #43

ethanknox-palmetto opened this issue Dec 2, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@ethanknox-palmetto
Copy link
Contributor

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?

  • I have searched the existing issues
@ethanknox-palmetto ethanknox-palmetto added enhancement New feature or request documentation Improvements or additions to documentation good first issue Good for newcomers labels Dec 2, 2021
@jakeberesford-palmetto
Copy link
Collaborator

This would be a solid improvement to our published docs!

https://sphinxcontrib-napoleon.readthedocs.io/en/latest/

Seems pretty straightforward to set up with Napoleon

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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants