porymap/docs/_sources
2019-05-16 17:05:27 -05:00
..
manual finish region map editor docs 2019-04-29 19:48:50 -05:00
reference 1.2.2 Release 2019-05-16 17:05:27 -05:00
index.rst.txt begin region map editor documentation 2019-04-29 19:48:50 -05:00
README.md.txt 1.2.2 Release 2019-05-16 17:05:27 -05: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
```