mirror of
https://github.com/huderlem/porymap.git
synced 2026-09-15 20:35:25 -05:00
8e83daac84
- Project config is now split into project and user config. - Backwards compatibility with the old project config included, porting old project items over to the new user config.
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