Writing Documentation

How to write and publish documentation.

Editing docs

  1. Clone the repo and create a branch (or commit straight to main — pushes to main trigger a rebuild on the server).

  2. Add or edit pages in docs/ — Markdown (.md) or reStructuredText (.rst) both work.

  3. New pages must be added to the toctree in index.rst to appear in the sidebar.

Building locally

pip install -r requirements.txt
sphinx-build -b html docs docs/_build/html
open docs/_build/html/index.html

Or with live reload while writing:

pip install sphinx-autobuild
sphinx-autobuild docs docs/_build/html

Publishing

Push to main. The Virginia server rebuilds the site automatically and serves it at https://wiki.artbnkr.com.