README.md

MC² Website

This site is automatically rebuilt upon pushes to master in this repo, and also to pushes to master at the client and Opaque SQL.

Documentation Development

To build the documentation locally, install the sphinx and sphinx-argparse Python packages, then build the documentation from this directory.

sudo apt-get install -y enchant
pip3 install furo sphinx sphinx-argparse sphinx-copybutton sphinxcontrib-spelling
make html

To view the documentation in a browser, open the generated index.html file.

open _build/html/index.html

To run spellcheck:

sphinx-build -b spelling . _build

To add correctly spelled words to the dictionary (and prevent spellcheck errors on these words), modify spelling_wordlist.txt.