cookiecutter-data-science/docs
Jordan Bramble e69ae335a4 updates docs to reflect new directory structure; adds more general name to visualization directory 2016-04-27 00:51:04 -04:00
..
docs updates docs to reflect new directory structure; adds more general name to visualization directory 2016-04-27 00:51:04 -04:00
README.md Initial docs commit 2016-04-23 12:19:28 -04:00
mkdocs.yml GA quick fix. 2016-04-25 17:26:51 -04: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.