InstituteforDiseaseModeling / cookiecutter-python-library

0 stars 3 forks source link

Support read the docs #6

Open devclinton opened 4 years ago

devclinton commented 4 years ago

This project allows user to start with a template for starting python libraries. To encourage users to have documentation from the start, the template should over a clear path to publish to read the docs

Currently

@JSchripsema-IDM - I would like to work with you on the second part. What we typically happen in the a new library workflow is something like

  1. cookiecutter gh:InstituteforDiseaseModeling/cookiecutter-python-library
  2. User answers all questions, they will have a starter project read to go
  3. At some point, the library will be published and we will want to also publish docs.
devclinton commented 4 years ago

Also this is low priority. I just want to capture what we have done in idmtools/emodpy/ etc for others to reduce friction. If we do that, I think we can easily provide users a pathway to documentation without much overhead