!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

387 Members
Discussion about documentation improvements around the Nix ecosystem84 Servers

Load older messages


SenderMessageTime
30 Nov 2024
@fricklerhandwerk:matrix.orgfricklerhandwerk

You have to add entries to nixos/doc/manual/redirects.json, which look like this:

  "<identifier>": [
    "index.html#<identifier>",
  ]

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 <identifier>, then the shape will have to be

  "<identifier>": [
    "<path/to/output/location>.html#<identifier>",
  ]
15:14:04
2 Dec 2024
@pyrox:pyrox.devdish [Fox/It/She] changed their profile picture.19:59:19
3 Dec 2024
@getchoo:matrix.orggetchoo changed their profile picture.06:06:36
7 Dec 2024
@tek:tryp.io@tek:tryp.io left the room.20:23:19
9 Dec 2024
@karlericsson:matrix.orgkarlericsson joined the room.08:01:46
14 Dec 2024
@yut0:matrix.orgyut0 joined the room.22:42:39
@yut0:matrix.orgyut0Anyone 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 nixpkgs22:44:40
@toonn:matrix.orgtoonn yut0: Are you maybe looking for `man configuration.nix`? 23:46:31
15 Dec 2024
@yut0:matrix.orgyut0Oh hell yeah thank you11:19:39
@yut0:matrix.orgyut0Do you know if there's a way to generate the html pages as well / if the equivalent exists for home-manager?11:21:27
@toonn:matrix.orgtoonn 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
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @yut0:matrix.org
Do you know if there's a way to generate the html pages as well / if the equivalent exists for home-manager?
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 source code, check its source code starting from default.nix, there’s a doc attribute that builds the module documentation
17:36:09
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @yut0:matrix.org
Do you know if there's a way to generate the html pages as well / if the equivalent exists for home-manager?
* 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
@mel:rnrd.euMel changed their profile picture.21:38:58
18 Dec 2024
@dmiskovic:matrix.org@dmiskovic:matrix.org joined the room.19:37:53
21 Dec 2024
@stablejoy:matrix.org@stablejoy:matrix.org left the room.05:08:24
@dmiskovic:matrix.org@dmiskovic:matrix.org left the room.05:13:53
@stablejoy:matrix.org@stablejoy:matrix.org joined the room.06:43:12
@dimitarnestorov:matrix.orgDimitar joined the room.19:42:45
22 Dec 2024
@stablejoy:matrix.org@stablejoy:matrix.org left the room.13:25:00
@allrealmsoflife:matrix.orgallrealmsoflife joined the room.15:55:13
24 Dec 2024
@yut0:matrix.orgyut0 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
@karlthane:matrix.orgkarlthane joined the room.14:11:28
26 Dec 2024
@elikoga:matrix.orgelikoga changed their display name from elikoga to elikoga (@38c3 πŸ“ž448{0,1}.15:21:37
@elikoga:matrix.orgelikoga changed their display name from elikoga (@38c3 πŸ“ž448{0,1} to elikoga (@38c3 πŸ“ž448{0,1}).15:25:56
@elikoga:matrix.orgelikoga changed their display name from elikoga (@38c3 πŸ“ž448{0,1}) to elikoga (@38c3 πŸ“ž488{0,1}).15:26:34
@phaer:matrix.orgphaer changed their display name from phaer to phaer (8650 at 38c3).17:41:23
@lorenzleutgeb:matrix.orgLorenz Leutgeb changed their display name from Lorenz Leutgeb to Lorenz Leutgeb (πŸ“ž6343).19:33:21
@lorenzleutgeb:matrix.orgLorenz Leutgeb changed their display name from Lorenz Leutgeb (πŸ“ž6343) to Lorenz Leutgeb πŸ“ž6343.19:36:36
@johannes.kirschbauer:scs.ems.hostDeleted -Johannes Kirschbauer- reach me via @hsjobeki:matrix.org instead
In reply to @yut0:matrix.org
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..
I think markdown is the html its just badly named
20:22:36

Show newer messages


Back to Room ListRoom Version: 6