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

Document python package on readthedocs #144

Open

jameslamb opened this issue Mar 4, 2019 · 0 comments

Labels

ci docs help wanted python

Collaborator

jameslamb commented Mar 4, 2019

The Python side of this project should be documented on RTD!

This involves:

Add sphinx setup stuff on the Python package
Add a.readthedocs.yml, e.g. https://github.com/jameslamb/doppel-cli/blob/master/.readthedocs.yml
Go to https://readthedocs.org/dashboard and set up the project (might be something I have to do as an UptakeOpenSource admin
Add a ReadTheDocs build status badge to the README

The text was updated successfully, but these errors were encountered:

jameslamb added help wanted python docs ci labels

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment