Documentation Deployment¶

The documentation is a static MkDocs site. Build it locally, then upload the generated site directory to any static web server.

Build¶

From the Documentation directory:

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
mkdocs build --strict

The deployable output is written to:

Documentation/site/

Preview¶

mkdocs serve

Open http://127.0.0.1:8000.

Nginx example¶

server {
    listen 80;
    server_name docs.example.com;
    root /var/www/pixit-turn-based-engine;
    index index.html;

    location / {
        try_files $uri $uri/ =404;
    }
}

Upload the contents of Documentation/site/ to /var/www/pixit-turn-based-engine.

Before publishing, replace YOUR-DOMAIN.com in mkdocs.yml with the final HTTPS URL.