Writing Documentation

New NixOps documentation uses a standard configuration of Sphinx. Older documentation is in Docbook, and should be ported to reStructuredtext.

See Sphinx’s primer on reStructuredText (reST): https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html.

The NixOps repo has live-reloading support:

nixops$ ./live-docs.py
Serving on

Visit in your browser. As you edit and save .rst files, your browser will automatically reload.

Before Committing

Validate the source files for correctly written reST and spelling:

nixops$ ./ci/lint-docs.sh

Fix any errors before committing.