rbrott / gm0

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

Home Page:https://gm0.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Game Manual 0

Docs Badge CI Badge Link Check

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 -r 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

About

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

https://gm0.org

License:Other


Languages

Language:Python 80.3%Language:CSS 8.0%Language:Makefile 7.0%Language:Shell 4.7%