Document your Nix code with Sphinx

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 set up 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 over the benefits the Sphinx documentation system provides when used with this plugin.

Resources:

• sphinxcontrib-nixdomain documentation
• sphinxcontrib-nixdomain source code
• Sphinx documentation
• EPNix documentation, my work project that extensively uses sphinxcontrib-nixdomain