Roles

Tip

With Intersphinx, these cross-references can resolve to objects defined in an external Sphinx project. See Cross-references for more information.

:nix:obj:

Refer to any object defined by sphinxcontrib-nixdomain.

Example

See the {nix:obj}`services.autobar.enable` object.

Renders:

See the services.autobar.enable object.

:nix:option:

Refer to an option from the NixOS module system.

Example

See the {nix:option}`services.autobar.enable` option.

Renders:

See the services.autobar.enable option.

:nix:pkg:

Refer to a Nix package.

Example

See the {nix:pkg}`hello` package.

Renders:

See the hello package.

:nix:func:

Refer to a Nix function.

Example

See the {nix:func}`exampleLib.myFunc` function.

Renders:

See the exampleLib.myFunc function.