porymap/docs/_sources
2020-03-04 11:48:19 -06:00
..
manual Update documentation 2020-03-04 11:48:19 -06:00
reference Update documentation 2020-03-04 11:48:19 -06:00
index.rst.txt add list of files porymap edits to docs 2019-10-16 20:04:19 -05:00
README.md.txt Update documentation 2020-03-04 11:48:19 -06:00

This directory holds the sources that build the porymap documentation website. It uses Sphinx to build a static website, and copy the results to the `docs/` directory for GitHub Pages.

## Setup
Sphinx uses Python, so you can use `pip` to install the dependencies:
```
pip install -r requirements.txt
```

## Build
This will build the static site and copy the files to the root-level `docs/` directory.  The GitHub Pages site will automatically update when the commit is merged to porymap's `master` branch.
```
make github
```