tabletop-club/docs

Tabletop Club Documentation

The documentation is built using Sphinx.

Requirements

To build the documentation, you will first need to create a Python virtual environment so you can install packages without affecting your system:

python3 -m venv env

Then, activate the environment and install the necessary packages:

source env/bin/activate
pip3 install -r requirements.txt

Once you are done building the documentation, you can then use deactivate at any time to exit out of the virtual environment:

deactivate

Building

To build the documentation on macOS and Linux:

make html

To build the documentation on Windows:

make.bat html

You can then view the documentation by opening _build/html/index.html in the web browser of your choice.

Cleaning

To clean the build files on macOS and Linux:

make clean

To clean the build files on Windows:

make.bat clean