cookiecutter-data-science/docs
Natrave Drova 78e001f742
Tox reference (#211)
* Use a better link to the tox project

* Use a better link to the tox project

* Use a better link to the tox project
2020-04-22 22:14:31 -07:00
..
docs Tox reference (#211) 2020-04-22 22:14:31 -07:00
README.md Initial docs commit 2016-04-23 12:19:28 -04:00
mkdocs.yml Add edit_uri to mkdocs.yml 2018-11-29 13:08:46 -07:00

README.md

Generating the docs

Install requirements:

pip install -r requirements.txt

Change directories into the docs folder:

cd docs

Use mkdocs structure to update the documentation. Test locally with:

mkdocs serve

Once the docs look good, publish to gh-pages branch with:

mkdocs gh-deploy --clean

** Note **: Never edit the generated site by hand because using gh-deploy blows away the gh-pages branch and you'll lose your edits.