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

Automatically generate docs #141

Open
suchak1 opened this issue Nov 18, 2021 · 0 comments
Open

Automatically generate docs #141

suchak1 opened this issue Nov 18, 2021 · 0 comments

Comments

@suchak1
Copy link
Owner

suchak1 commented Nov 18, 2021

google "python library docs generator", pick best one, and refactor library to autogenerate docs

get a linter to make sure functions are compliant w doc generation during pr validation?

generate html doc, push to forcepu.sh bucket (better for making docs public acl read - remove delete flag from deploy units workflow) or hyperdrive bucket (better for showing docs from hyperdrive) and serve from forcepush - pull in locally as part of build process s3 download w creds (hyperdrive bucket) or just make request to object url (public access - forcepush bucket) or git checkout hyperdrive and generate docs on the fly

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant