hongzhonglu/genomics

Sphinx documentation source for a computational genomics tutorial.

Computational Genomics Tutorial pages

A computational genomics tutorial with continuous integration, using Travis-CI, and deployment, using Netlify, and sphinx.

The production version of the deployed site:

• https://genomics.netlify.com
• https://genomics.readthedocs.io/
• https://genomics.sschmeier.com

Details

• Netlify runs Ubuntu Xenial 16.04 build, with a python3.5 installed.
• Thus, need to use py3.5

Local development of tutorial

1. Set up a python virtual environment named venv => pip install virtualenv; virtualenv --python=python3.5 venv.
2. Activate the venv environment => source venv/bin/activate
3. Install the dependencies inside of it by running pip install -r requirements_dev.txt.
4. Run make htmlwatch.
5. Edit your rst-files.
6. Commit changes
7. Bump version using, e.g. bump2version patch
8. Push changes to remote