Files
porymap/docsrc
tustin2121 3d9cd2ad0d Moving paths to project config
- Replaced all instances of hardcoded paths with requesting a path from the new project config file properties for "path/".
- As a result, all default paths hardcoded into porymap are now in one place.
- When reading the config file, it now trims out white space around the key and value.
2022-09-01 12:14:47 -04:00
..
2022-09-01 12:14:47 -04:00
2020-05-14 19:54:56 -05:00
2019-04-18 19:36:49 -05:00
2020-10-14 19:19:17 -05:00
2022-07-11 22:06:17 -04:00
2019-04-18 19:36:49 -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