Event

Event
16:55
-
17:15
Day 1
Document your Nix code with Sphinx
Assembly-Event
<p>Introducing <a href="https://github.com/minijackson/sphinxcontrib-nixdomain/"><code>sphinxcontrib-nixdomain</code></a>! A plugin for the <a href="https://www.sphinx-doc.org/">Sphinx</a> documentation generator that takes your Nix code and generates documentation for NixOS options, Nix packages, and Nix functions.</p> <p>This talk shows how to set up <code>sphinxcontrib-nixdomain</code> for your project, how to generate documentation for Nix objects, and how to add cross-references to those Nix objects.</p> <p>We'll also go over the benefits the Sphinx documentation system provides when used with this plugin.</p> <p>Resources:</p> <ul> <li><a href="https://sphinxcontrib-nixdomain.readthedocs.io/"><code>sphinxcontrib-nixdomain</code> documentation</a></li> <li><a href="https://github.com/minijackson/sphinxcontrib-nixdomain/"><code>sphinxcontrib-nixdomain</code> source code</a></li> <li><a href="https://www.sphinx-doc.org/">Sphinx documentation</a></li> <li><a href="https://epics-extensions.github.io/EPNix/">EPNix documentation</a>, my work project that extensively uses <code>sphinxcontrib-nixdomain</code></li> </ul>