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.

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

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:

How to see the options for building:

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.

Name	Name	Last commit message	Last commit date
Latest commit CooperLi1 Update gallery/cad pages (gamemanual0#297 ) Dec 20, 2022 84f18b4 · Dec 20, 2022 History 455 Commits
.devcontainer	.devcontainer	Add Github Codespace support (gamemanual0#302 )	Nov 13, 2022
.github	.github	Master -> Main (gamemanual0#174 )	Apr 16, 2021
.vscode	.vscode	Add basic VSCode tasks.json (gamemanual0#303 )	Nov 13, 2022
source	source	Update gallery/cad pages (gamemanual0#297 )	Dec 20, 2022
.gitignore	.gitignore	Add basic VSCode tasks.json (gamemanual0#303 )	Nov 13, 2022
.readthedocs.yaml	.readthedocs.yaml	Disable epub build, set the version to 0 (gamemanual0#267 )	Aug 12, 2022
LICENSE	LICENSE	Make sure all files have unix newlines	Jul 16, 2020
Makefile	Makefile	Improve windows build compatibility (gamemanual0#243 )	Jul 24, 2022
README.md	README.md	Fix broken lists, standardize on "-" for lists (gamemanual0#254 )	Aug 1, 2022
make.bat	make.bat	Improve windows build compatibility (gamemanual0#243 )	Jul 24, 2022
poetry.lock	poetry.lock	Bump dependencies (gamemanual0#227 )	May 23, 2022
pyproject.toml	pyproject.toml	Add Github Codespace support (gamemanual0#302 )	Nov 13, 2022