Automatic packages

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 package set

To document a whole set of package, use the nix:autopackages directive.

Document everything

To document every package found, don’t pass any argument to the directive.

For example:

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

```{autopackages}
```

Renders:

example1[source]

broken insecure unfree

An example package

Name:

example1

Version:

0.1.0

Licenses:

  • Unfree

Maintainers:

none declared

More information can be added in the longDescription meta attribute.

You can also use field lists to document things like overrides:

Overrides:

  • myFeature (bool) – whether to enable my feature

  • modules (list of str) – modules to compile

hello[source]

Program that produces a familiar, friendly greeting

Name:

hello

Version:

2.12.2

Homepage:

https://www.gnu.org/software/hello/manual/

Changelog:

https://git.savannah.gnu.org/cgit/hello.git/plain/NEWS?h=v2.12.2

Licenses:
Maintainers:

GNU Hello is a program that prints “Hello, world!” when you run it. It is fully customizable.

scope."special name"[source]

Program that produces a familiar, friendly greeting

Name:

hello

Version:

2.12.2

Homepage:

https://www.gnu.org/software/hello/manual/

Changelog:

https://git.savannah.gnu.org/cgit/hello.git/plain/NEWS?h=v2.12.2

Licenses:
Maintainers:

GNU Hello is a program that prints “Hello, world!” when you run it. It is fully customizable.

scope.nimScript[source]
Name:

test

Maintainers:

none declared

Document a subset

To render only a subset of function, pass the desired scope to the directive.

For example:

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

```{autopackages} scope
```

Renders:

scope."special name"[source]

Program that produces a familiar, friendly greeting

Name:

hello

Version:

2.12.2

Homepage:

https://www.gnu.org/software/hello/manual/

Changelog:

https://git.savannah.gnu.org/cgit/hello.git/plain/NEWS?h=v2.12.2

Licenses:
Maintainers:

GNU Hello is a program that prints “Hello, world!” when you run it. It is fully customizable.

scope.nimScript[source]
Name:

test

Maintainers:

none declared

Document a single package

To document a single package, use the nix:autopackage directive.

For example:

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

```{autopackage} hello
```

Renders:

hello[source]

Program that produces a familiar, friendly greeting

Name:

hello

Version:

2.12.2

Homepage:

https://www.gnu.org/software/hello/manual/

Changelog:

https://git.savannah.gnu.org/cgit/hello.git/plain/NEWS?h=v2.12.2

Licenses:
Maintainers:

GNU Hello is a program that prints “Hello, world!” when you run it. It is fully customizable.