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-generate rocket docs #579

Open
SarahBornais opened this issue Oct 17, 2020 · 1 comment
Open

Auto-generate rocket docs #579

SarahBornais opened this issue Oct 17, 2020 · 1 comment
Labels
needs research Do research and exploratory work theme:docs Create or update documentation theme:refactoring Something needs to be cleaned up or refactored

Comments

@SarahBornais
Copy link
Member

Summary

Auto-generate rocket docs to centralize documentation maintenance.

Requirements

Research some good python documentation tools (this looks like a good place to start) and migrate documentation from the Rocket documentation website and /rocket help to docstrings in the code. Update the existing documentation resources to use the auto-generated docs.

Context

Brought up in October 17th meeting - maintaining docs in multiple places is difficult and leads to inconsistencies.

@SarahBornais SarahBornais added theme:refactoring Something needs to be cleaned up or refactored needs research Do research and exploratory work labels Oct 17, 2020
@chuck-sys chuck-sys added the theme:docs Create or update documentation label Oct 17, 2020
@bobheadxi
Copy link
Member

bobheadxi commented Oct 17, 2020

for reference, Inertia has generated docs for its CLI published on a website, so some equivalent tooling for argparse likely exists out there if we go that route: https://inertia.ubclaunchpad.com/cli/

https://github.com/ubclaunchpad/inertia/blob/master/contrib/inertia-docgen/main.go

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs research Do research and exploratory work theme:docs Create or update documentation theme:refactoring Something needs to be cleaned up or refactored
Projects
None yet
Development

No branches or pull requests

3 participants