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.

Sign up for GitHub

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

Jump to bottom

Deploy the documentation to read the docs #122

Open
mprahl opened this issue Mar 30, 2020 · 1 comment
Open

Deploy the documentation to read the docs #122

mprahl opened this issue Mar 30, 2020 · 1 comment

Comments

@mprahl
Copy link
Contributor

mprahl commented Mar 30, 2020

Cachito uses RST docstrings, so we should take advantage of that by generating documentation from them using sphinx and publishing it to Read the Docs.

See the following commits in IIB that did this for inspiration:
release-engineering/iib@5d53652
release-engineering/iib@f1874eb
@tkdchen
Copy link
Contributor

tkdchen commented Apr 22, 2020

It would be good to include "Enable regular autobuild" as a step of this work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tkdchen @mprahl