!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

364 Members
This is the official channel for documentation in the Nix ecosystem. The documentation team meets here. More information: https://nixos.org/community/teams/documentation Video conference: https://jitsi.lassul.us/nix-documentation Meeting notes scratch pad: https://pad.lassul.us/p-Y8MjU2SdSD5qO1fnpCPA Past meeting notes: https://discourse.nixos.org/search?q=documentation%20team%20meeting%20order%3Alatest 74 Servers

Load older messages


SenderMessageTime
26 Dec 2024
@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
@johannes.kirschbauer:scs.ems.hostDeleted -Johannes Kirschbauer- reach me via @hsjobeki:matrix.org insteadYou can use this: https://noogle.dev/f/pkgs/nixosOptionsDoc You need to look into the source Code for documentation unfortunately 20:24:13
@johannes.kirschbauer:scs.ems.hostDeleted -Johannes Kirschbauer- reach me via @hsjobeki:matrix.org insteadIt depends what you want to do really. If you give more details what you want to do there might be a better way20:27:31
27 Dec 2024
@raitobezarius:matrix.orgraitobezarius changed their display name from raitobezarius to raitobezarius (DECT: 3538 / EPVPN 2681).07:33:13
@garbas:matrix.org@garbas:matrix.org left the room.10:29:14
@dimitarnestorov:matrix.orgDimitar set a profile picture.11:41:11
@dimitarnestorov:matrix.orgDimitar changed their display name from dimitarnestorov to Dimitar.11:42:10
28 Dec 2024
@matthewcroughan:defenestrate.itmatthewcroughan changed their display name from matthewcroughan to matthewcroughan (DECT: 56490).18:39:33
29 Dec 2024
@elikoga:matrix.orgelikoga changed their display name from elikoga (@38c3 📞488{0,1}) to elikoga (@38c3 📞488{0,1,9}).11:02:52
30 Dec 2024
@dimitarnestorov:matrix.orgDimitar Hey, could I get some guidance on this PR? What should I do next? Can I help somehow or maybe wait for something? https://github.com/NixOS/nixpkgs/pull/363755 10:28:10
@raitobezarius:matrix.orgraitobezarius changed their display name from raitobezarius (DECT: 3538 / EPVPN 2681) to raitobezarius.16:29:44
@matthewcroughan:defenestrate.itmatthewcroughan changed their display name from matthewcroughan (DECT: 56490) to matthewcroughan.17:25:52
31 Dec 2024
@getchoo:matrix.orggetchoo changed their profile picture.12:38:52
@siraben:matrix.org@siraben:matrix.org left the room.14:51:22
@phaer:matrix.orgphaer changed their display name from phaer (8650 at 38c3) to phaer.19:23:44
@yukiisbored:matrix.orgYuki Langley (they/them) changed their profile picture.19:36:12
@yukiisbored:matrix.orgYuki Langley (they/them) changed their display name from Yuki (they/them) to Yuki Langley (they/them).19:36:25
1 Jan 2025
@mjolnir:nixos.orgNixOS Moderation Botchanged room power levels.14:26:30
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @dimitarnestorov:matrix.org
Hey, could I get some guidance on this PR? What should I do next? Can I help somehow or maybe wait for something? https://github.com/NixOS/nixpkgs/pull/363755
It looks good, nothing to do here really. I'd hit the button, but GitHub doesn't want me to do a rebase for some reason, and I'm not sure if merge commits are desirable. getchoo any idea?
17:11:54
@dimitarnestorov:matrix.orgDimitarRebased on master17:21:06
2 Jan 2025
@hashphoenix:matrix.orgOluwapelumi Adeosun joined the room.10:16:01
@error_pro:matrix.orgerror_pro joined the room.10:44:29
3 Jan 2025
@elikoga:matrix.orgelikoga changed their display name from elikoga (@38c3 📞488{0,1,9}) to elikoga.10:28:01
4 Jan 2025
@kranzes:matrix.org@kranzes:matrix.org left the room.15:30:41
7 Jan 2025
@ruroruro:matrix.org@ruroruro:matrix.org left the room.03:43:11
@allrealmsoflife:matrix.orgallrealmsoflife

Hello,

I'm trying to build the Nix manual following the instructions here:
https://nix.dev/manual/nix/2.25/development/documentation.

I have a few questions about the process:

  1. Where should I run the build command?
    For example, do I need to be in a specific directory for the commands to work correctly?

  2. Issues with nix-build output:
    When I run the following command in the src/nix directory:

    nix-build -E '(import ./.).packages.${builtins.currentSystem}.nix.doc'
    

    It generates a result directory, but it does not contain the expected index.html
    in a path like ./result-doc/share/doc/nix/manual/index.html. Instead, I see several
    subdirectories with their own index.html files. Additionally, there is no
    result-doc directory, only result. Is this the intended behavior?

  3. Error with nix build:
    When I try to use the newer command:

    nix build .#nix^doc
    

    I get the following error:

    error: derivation '/nix/store/91q76nmlb2aharvh227hlgv6xq78610m-nix-2.26.0pre20250102_442a262.drv' 
    does not have wanted outputs 'doc'
    

Could you clarify what might be going wrong or what adjustments I need to make? Thank you for your help!

08:39:56
@allrealmsoflife:matrix.orgallrealmsoflife

Also when I try the third option, enter the development shell, and run:

[nix-shell:~/src/nix]$ make manual-html-open -j $NIX_BUILD_CORES
make: *** No rule to make target 'manual-html-open'.  Stop.
09:15:40
@fricklerhandwerk:matrix.orgfricklerhandwerk Hey allrealmsoflife! Thanks for sharing feedback. 15:07:09

Show newer messages


Back to Room ListRoom Version: 6