NixOS/nix.dev
NixOS/nix.dev
1
0
Fork 0
mirror of https://github.com/NixOS/nix.dev.git synced 2024-10-18 14:32:43 -04:00
Code Activity
nix.dev/source/reference/nix-manual.md

32 lines
1 KiB
Markdown
Raw Normal View History

host Nix reference manual on nix.dev this is the most cursed setup you will see any time soon. we're dumping the Nix manual unchanged into the build tree *after* building. the reason is that we'd want to link to it from our table of contents, but because Sphinx does not allow adding arbitrary files to the build output in arbitrary locations (only `_static` works). but we want to place the manual behind a particular URL, and the alternative of maintaining URL rewrites (e.g. in nginx) is not accessible here because the infrastructure is managed somewhere else. now that the files won't appear in their desired locations at Sphinx build time, we can't use relative links to reference them, therefore we have to resort to pointing to the web URL the manual will appear at. this is terrible and I'm sorry. please fix this if you have a better idea. once we use URLs though, we have to avoid linkchecking, since those files may not be there before deploying them. figuring all of this out took way longer than anyone would wish. Co-authored-by: Alejandro Sanchez Medina <alejandrosanchzmedina@gmail.com>
2023-10-18 06:04:34 -04:00
(nix-manual)=
# Nix reference manual
```{toctree}
:hidden:
Nix pre-release (development) <https://hydra.nixos.org/job/nix/master/build.x86_64-linux/latest/download>
Nix 2.19 (latest) <https://nix.dev/manual/nix/2.19/>
Nix 2.18 (rolling) <https://nix.dev/manual/nix/2.18/>
update all links to the Nix manual
2023-11-01 22:41:54 -04:00
Nix 2.13 (stable) <https://nix.dev/manual/nix/2.18/>
host Nix reference manual on nix.dev this is the most cursed setup you will see any time soon. we're dumping the Nix manual unchanged into the build tree *after* building. the reason is that we'd want to link to it from our table of contents, but because Sphinx does not allow adding arbitrary files to the build output in arbitrary locations (only `_static` works). but we want to place the manual behind a particular URL, and the alternative of maintaining URL rewrites (e.g. in nginx) is not accessible here because the infrastructure is managed somewhere else. now that the files won't appear in their desired locations at Sphinx build time, we can't use relative links to reference them, therefore we have to resort to pointing to the web URL the manual will appear at. this is terrible and I'm sorry. please fix this if you have a better idea. once we use URLs though, we have to avoid linkchecking, since those files may not be there before deploying them. figuring all of this out took way longer than anyone would wish. Co-authored-by: Alejandro Sanchez Medina <alejandrosanchzmedina@gmail.com>
2023-10-18 06:04:34 -04:00
```
- [Nix pre-release](https://hydra.nixos.org/job/nix/master/build.x86_64-linux/latest/download)
Reference documentation for the latest build from the `master` branch of the [Nix repository](https://github.com/NixOS/nix)
- [Nix 2.19](https://nix.dev/manual/nix/2.19/)
Reference documentation for the latest Nix release
- [Nix 2.18](https://nix.dev/manual/nix/2.18/)
Reference documentation for the Nix version shipped with the {term}`Nixpkgs` and {term}`NixOS` rolling release
update all links to the Nix manual
2023-11-01 22:41:54 -04:00
- [Nix 2.13](https://nix.dev/manual/nix/2.13/)
host Nix reference manual on nix.dev this is the most cursed setup you will see any time soon. we're dumping the Nix manual unchanged into the build tree *after* building. the reason is that we'd want to link to it from our table of contents, but because Sphinx does not allow adding arbitrary files to the build output in arbitrary locations (only `_static` works). but we want to place the manual behind a particular URL, and the alternative of maintaining URL rewrites (e.g. in nginx) is not accessible here because the infrastructure is managed somewhere else. now that the files won't appear in their desired locations at Sphinx build time, we can't use relative links to reference them, therefore we have to resort to pointing to the web URL the manual will appear at. this is terrible and I'm sorry. please fix this if you have a better idea. once we use URLs though, we have to avoid linkchecking, since those files may not be there before deploying them. figuring all of this out took way longer than anyone would wish. Co-authored-by: Alejandro Sanchez Medina <alejandrosanchzmedina@gmail.com>
2023-10-18 06:04:34 -04:00
Reference documentation for the Nix version shipped with the current {term}`Nixpkgs` and {term}`NixOS` stable release
link to new Nix reference manual page
2023-11-26 18:13:51 -05:00
:::{tip}
More information on Nixpkgs and NixOS releases: [](channel-branches)
:::
Copy permalink