Nix Documentation | 400 Members | |
| Discussion about documentation improvements around the Nix ecosystem | 78 Servers |
| Sender | Message | Time |
|---|---|---|
| 30 Nov 2024 | ||
| You have to add entries to
Rationale and design documentation: https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/ni/nixos-render-docs/README.md Once the page-split is performed, you'll also have to consider the output path of the element referred to by
| 15:14:04 | |
| 2 Dec 2024 | ||
| 19:59:19 | ||
| 3 Dec 2024 | ||
| 06:06:36 | ||
| 7 Dec 2024 | ||
| 20:23:19 | ||
| 9 Dec 2024 | ||
| 08:01:46 | ||
| 14 Dec 2024 | ||
| 22:42:39 | ||
| Anyone know if there is a way to generate the Appendix A page for nixpkgs (and also home-manager, nix-darwin) using the local pinned version in my flake? I don't update my flake inputs too often, so sometimes the online Appendix A pages drift from my local nixpkgs | 22:44:40 | |
| yut0: Are you maybe looking for `man configuration.nix`? | 23:46:31 | |
| 15 Dec 2024 | ||
| Oh hell yeah thank you | 11:19:39 | |
| Do you know if there's a way to generate the html pages as well / if the equivalent exists for home-manager? | 11:21:27 | |
| yut0: `man home-configuration.nix` I have no idea about generation of the html pages I'm sure someone else will chime in though. | 11:26:28 | |
In reply to @yut0:matrix.orgFor figuring out how the appendix is built, check the Nixpkgs repo in doc/default.nix and follow the call graph from there. Home Manager uses the same source code, check its source code starting from default.nix, thereβs a doc attribute that builds the module documentation | 17:36:09 | |
In reply to @yut0:matrix.org* For figuring out how the appendix is built, check the Nixpkgs repo in doc/default.nix and follow the call graph from there. Home Manager uses the same tooling, check its source code starting from default.nix, thereβs a doc attribute that builds the module documentation | 17:36:24 | |
| 21:38:58 | ||
| 18 Dec 2024 | ||
| 19:37:53 | ||
| 21 Dec 2024 | ||
| 05:08:24 | ||
| 05:13:53 | ||
| 06:43:12 | ||
| 19:42:45 | ||
| 22 Dec 2024 | ||
| 13:25:00 | ||
| 15:55:13 | ||
| 24 Dec 2024 | ||
What's the canonical way of generating the options html pages? pkgs.nixpkgs-manual.override { nixpkgs = <your current instance>; } seems like the way to go for the main manual page, but it doesn't build the options page. pkgs.nixpkgs-manual.optionsDoc has derivations for asciidoc, markdown, and json, but no html.Alternatively, it looks like you can directly call the same derivation hydra uses to build these pages, i.e. "${(import "${nixpkgs}/nixos/release.nix" { inherit nixpkgs; }).manualHTML.x86_64-linux}/share/doc/nixos", which does build all of the manual pages, but this seems cursed.. | 02:13:35 | |
| 14:11:28 | ||
| 26 Dec 2024 | ||
| 15:21:37 | ||
| 15:25:56 | ||
| 15:26:34 | ||
| 17:41:23 | ||
| 19:33:21 | ||
| 19:36:36 | ||
In reply to @yut0:matrix.orgI think markdown is the html its just badly named | 20:22:36 | |