blalond / 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.

Currently, building Game Manual 0 is only supported on POSIX systems.

Requirements

• Python 3
• TexLive
• dvipng
• graphviz
• make

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

Building

How to check if the documentation is valid:

• make lint
• 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:

• make autobuild