nixpkgs/nixos/doc/manual
Domen Kožar 5cfd034af0
Extract NixOS options documentation generation to a function
Motivation is to support other repositories containing nixos
modules that would like to generate options documentation:

- nix-darwin
- private repos
- arion
- ??
2019-08-08 16:18:09 +02:00
..
administration doc: Use prompt more often 2019-06-17 13:25:50 +02:00
configuration nixos/xserver: add option to install custom xkb layouts (#47764) 2019-07-26 20:43:37 +02:00
development doc: Use prompt more often 2019-06-17 13:25:50 +02:00
installation doc: Use prompt more often 2019-06-17 13:25:50 +02:00
release-notes nixos/release-notes: add note about prometheus-exporters 2019-08-02 18:50:02 +02:00
.gitignore nixos docs: ignore generated files 2018-05-01 19:50:02 -04:00
default.nix Extract NixOS options documentation generation to a function 2019-08-08 16:18:09 +02:00
Makefile nixos manual Makefile: improve purity 2019-03-22 14:48:08 +01:00
man-configuration.xml nixos docs: format =) 2018-05-01 19:57:09 -04:00
man-nixos-build-vms.xml nixos-build-vms: pass --option to nix-build 2019-02-04 10:46:12 +01:00
man-nixos-enter.xml nixos/doc: ran make format 2018-05-31 21:03:51 -04:00
man-nixos-generate-config.xml doc: Use prompt more often 2019-06-17 13:25:50 +02:00
man-nixos-install.xml doc: Use prompt more often 2019-06-17 13:25:50 +02:00
man-nixos-option.xml doc: Use prompt more often 2019-06-17 13:25:50 +02:00
man-nixos-rebuild.xml doc: Use prompt more often 2019-06-17 13:25:50 +02:00
man-nixos-version.xml nixos/doc: ran make format 2018-05-31 21:03:51 -04:00
man-pages.xml nixos/doc+manual: change copyright year 2018->2019 2019-08-02 10:45:04 -05:00
manual.xml docs: format 2018-09-29 20:51:11 -04:00
README
shell.nix doc: Adds xml fixing script. (see previous and next commits) 2018-05-31 21:02:15 -04:00

To build the manual, you need Nix installed on your system (no need
for NixOS). To install Nix, follow the instructions at

    https://nixos.org/nix/download.html

When you have Nix on your system, in the root directory of the project
(i.e., `nixpkgs`), run:

    nix-build nixos/release.nix -A manual.x86_64-linux

When this command successfully finishes, it will tell you where the
manual got generated.