Automatic NixOS-like options

Tip

Click the [source] link next to the object to open the declaration source file.

Click the eye icon in the upper-right of the page to open the Markdown source file.

Document a whole module

To document a whole module, use the nix:automodule directive.

For example:

```{default-domain} nix
```

```{automodule} services.autobar
```

Renders:

services.autobar.enable boolean

Whether to enable the Bar service.

Default value

false

Example

true

services.autobar.openFirewall unspecified value

Whether to automatically open the firewall.

Warning

This opens the firewall on all network interfaces.

Added in version nixos-24.05.

Default value

false

Example

true

services.autobar.package package

The hello package to use.

Default value

pkgs.hello

services.autobar.pkg package

Alias of services.autobar.package.

Document a single option

To document a single option, use the nix:autooption directive.

For example:

```{default-domain} nix
```

```{autooption} services.autobar.enable
```

Renders:

services.autobar.enable boolean

Whether to enable the Bar service.

Default value

false

Example

true