Introducing sphinxcontrib-nixdomain! A plugin for the Sphinx documentation generator that takes your Nix code, and generates documentation for NixOS options, Nix packages, and Nix functions.

This talk shows how to setup Sphinx and sphinxcontrib-nixdomain for your project, how to generate documentation for Nix objects, and how to add cross-references to those Nix objects.

We'll also go into some documentation architecture best practices and personal advice, to hopefully make your documentation easy to use, browse, and understand.

Resources:

• sphinxcontrib-nixdomain documentation
• sphinxcontrib-nixdomain source code
• Sphinx documentation
• EPNix documentation, an example project that extensively uses sphinxcontrib-nixdomain