nixpkgs/nixos/doc/manual/development
pennae fc614c37c6 nixos/documentation: split options doc build
most modules can be evaluated for their documentation in a very
restricted environment that doesn't include all of nixpkgs. this
evaluation can then be cached and reused for subsequent builds, merging
only documentation that has changed into the cached set. since nixos
ships with a large number of modules of which only a few are used in any
given config this can save evaluation a huge percentage of nixos
options available in any given config.

in tests of this caching, despite having to copy most of nixos/, saves
about 80% of the time needed to build the system manual, or about two
second on the machine used for testing. build time for a full system
config shrank from 9.4s to 7.4s, while turning documentation off
entirely shortened the build to 7.1s.
2022-01-02 19:46:13 +01:00
..
assertions.section.md nixos/doc: convert assertions and warnings section to CommonMark 2021-06-03 20:12:16 -07:00
building-nixos.chapter.md lib/modules: add mkImageMediaOverride docs 2021-08-05 18:53:59 -05:00
building-parts.chapter.md nixos: nixos/doc/manual/development/building-parts.xml to CommonMark 2021-07-03 12:01:42 +08:00
development.xml nixos: nixos/doc/manual/development/writing-modules.xml to CommonMark 2021-09-08 17:57:11 +08:00
freeform-modules.section.md nixos: nixos/doc/manual/development/freeform-modules.xml to CommonMark 2021-07-03 22:20:55 +08:00
importing-modules.section.md nixos: nixos/doc/manual/development/importing-modules.xml to CommonMark 2021-07-03 22:20:55 +08:00
linking-nixos-tests-to-packages.section.md manuals: Describe how to link NixOS tests from packages 2021-07-27 17:39:33 +02:00
meta-attributes.section.md nixos/documentation: split options doc build 2022-01-02 19:46:13 +01:00
nixos-tests.chapter.md nixos: nixos/doc/manual/devlopment/nixos-tests.xml to CommonMark 2021-09-08 15:47:16 +08:00
option-declarations.section.md nixos/doc: clean up defaults and examples 2021-10-04 12:47:20 +02:00
option-def.section.md nixos: nixos/doc/manual/development/option-def.xml to CommonMark 2021-07-03 22:20:55 +08:00
option-types.section.md nixos: nixos/doc/manual/development/option-types.xml to CommonMark 2021-07-03 22:20:55 +08:00
replace-modules.section.md nixos: nixos/doc/manual/development/replace-modules.xml to CommonMark 2021-07-03 22:20:55 +08:00
running-nixos-tests-interactively.section.md nixos/tests/test-driver: normalise test driver entrypoint(s) 2021-08-05 19:07:11 -05:00
running-nixos-tests.section.md nixos: nixos/doc/manual/development/running-nixos-tests.xml to CommonMark 2021-07-02 20:23:38 +08:00
settings-options.section.md nixos: nixos/doc/manual/development/settings-options.xml to CommonMark 2021-07-03 22:20:55 +08:00
sources.chapter.md nixos: nixos/doc/manual/development/sources.xml to CommonMark 2021-07-03 12:00:40 +08:00
testing-installer.chapter.md nixos: nixos/doc/manual/development/testing-installer.xml to CommonMark 2021-07-03 12:06:27 +08:00
writing-documentation.chapter.md nixos: nixos/doc/manual/development/writing-documentation.xml to CommonMark 2021-07-03 12:09:57 +08:00
writing-modules.chapter.md nixos: nixos/doc/manual/development/writing-modules.xml to CommonMark 2021-09-08 17:57:11 +08:00
writing-nixos-tests.section.md nixosTest: Add xclip as example of stdout blocker 2021-11-06 13:46:51 +01:00