kevinfrei / gm0

Game Manual 0 - The most extensive guide out there for FTC

Game Manual 0

Welcome to Game Manual 0 (gm0)! This repository contains the source of Game Manual 0.

Building Game Manual 0

Game Manual 0 employs the Sphinx documentation generator, and the articles themselves are written in reStructuredText.

Requirements

• Python 3
• TexLive
• dvipng
• graphviz
• make

Ensure the Python requirements are installed via running python3 -m pip install -r source/requirements.txt.

Building

How to check if the documentation is valid:

• make lint (note: on Windows, make winlint will ignore CRLF line ending errors)
• make linkcheck

How to build the different versions of the documentation:

• make html
• make latexpdf

How to see the options for building:

• make help

How to develop the website:

• Run make autobuild
• This will set up a file watcher and build on file changes. A development server is served at http://127.0.0.1:8000 by default. Go to your preferred browser and open that URL to view your local development version of gm0.