fooyin Documentation

The source for the official fooyin documentation, built with Sphinx and deployed on Read the Docs.

The published documentation is available at fooyin.readthedocs.io.

Requirements

• Python 3.10 or newer
• pip
• Make
• Git

Arch Linux

Install the required packages:

sudo pacman -S --needed git make python python-pip

Getting Started

Clone the repository:

git clone https://github.com/fooyin/fooyin-docs.git
cd fooyin-docs

Create and activate a virtual environment:

python -m venv .venv
source .venv/bin/activate

Install the documentation dependencies:

python -m pip install -r docs/requirements.txt

Local Development

Build the HTML documentation:

make -C docs html

Open the generated site at:

docs/build/html/index.html

To rebuild from scratch:

make -C docs clean html

Build with warnings treated as errors before submitting changes:

make -C docs html SPHINXOPTS="-W --keep-going"

Deployment

Changes pushed to the master branch are automatically built and published by Read the Docs.