uptasticsearch icon indicating copy to clipboard operation
uptasticsearch copied to clipboard

Document python package on readthedocs

Open jameslamb opened this issue 5 years ago • 0 comments

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

jameslamb avatar Mar 04 '19 04:03 jameslamb