Automatic directives¶

Options¶

Sphinx directives for automatically documenting NixOS options, or any option in a NixOS-like module system.

.. nix:automodule:: [module]¶

Render all options documentation in the module module, recursively. If no module is given, render all modules.

For an example usage, see the Document a whole module example.

Options

:no-recursive:¶: If given, generate the documentation of options directly under the given module, without recursing into sub-modules.

.. nix:autooption:: <option>¶

Render documentation for the single option.

For an example usage, see the Document a single option example.

Sphinx directives for automatically documenting Nix packages.

.. nix:autopackages:: [scope]¶

Render all packages documentation in the scope scope, recursively. If no scope is given, render all packages found in the top-level scope.

For an example usage, see the Document a package set example.

Options

:no-recursive:¶: If given, generate the documentation of packages directly under the given scope, without recursing into sub-scopes.

.. nix:autopackage:: <package>¶

Render documentation for the single package.

For an example usage, see the Document a single package example.

Sphinx directives for automatically documenting a library of Nix functions.

.. nix:autolibrary:: [scope]¶

Render all functions documentation in the scope scope, recursively. If no scope is given, render all functions found in the top-level scope.

For an example usage, see the Document a function library example.

Options

:no-recursive:¶: If given, generate the documentation of functions directly under the given scope, without recursing into sub-scopes.

.. nix:autofunction:: <function>¶

Render documentation for the single function.

For an example usage, see the Document a single function example.