jdillard / continuous-sphinx

An example of continuous integration and deployment of a sphinx project

continuous-sphinx

An example of continuous integration, using Travis-CI, and deployment, using Netlify, of a sphinx project. This is also reffered to as Docs as Code and DocOps.

The production version of the deployed site, as well as additional documentation on the process, can be viewed here: https://continuous-sphinx.netlify.com/en/latest/

Installing Locally

1. Set up a python virtual environment named venv.
2. Activate the venv environment.
3. Install the dependencies inside of it by running pip install -r requirements.txt.
4. Run make html.