johnnovak / gridmonger-site

Gridmonger site & manual

This repo contains both the documentation sources and the GitHub Pages site for the Gridmonger project.

The GitHub Pages site is built from the /docs folder in the master branch.

The generated site can be viewed at https://gridmonger.johnnovak.net, and the actual user manual is here.

Requirements

• Sphinx 5.3+
• Sass 1.37+
• Make 3.8+
• GNU sed 4.8+
• Zip 3.0+

Building

• To build the site & manual, run make gen_html.

• To create the zipped distribution package of the manual from the generated files, run make dist_html.

• There are a few other make commands available to aid theme development (watch_docs_css and watch_frontpage_css).

License

Developed by John Novak <[e-mail]>, 2020-2022

This work is free. You can redistribute it and/or modify it under the terms of the Do What The Fuck You Want To Public License, Version 2, as published by Sam Hocevar. See the COPYING file for more details.