-
-
Notifications
You must be signed in to change notification settings - Fork 16.4k
Closed
Labels
0.kind: enhancementAdd something newAdd something new2.status: stalehttps://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.mdhttps://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md6.topic: documentationMeta-discussion about documentation and its workflowMeta-discussion about documentation and its workflow
Description
While DocBook is pretty great for a software product, our documentation workflow is not. One of the issues is the ease of building the docs – normally the user would just open a nix-shell
in the relevant directory and then call make
to build the HTML output, this is not the case everywhere.
It is not sufficient to provide commands like nix-build nixos/release.nix -A manual.x86_64-linux
in a README
, since it is not fine-grained enough, slow and hard to remember.
Currently, we have a somewhat working Makefile
in doc
(Nixpkgs docs) but the one in nixos/doc/manual
only contains a small number of targets and none for producing HTML. We should come up with a single set of targets that would be available in every Nix-related docs.
worldofpeace
Metadata
Metadata
Assignees
Labels
0.kind: enhancementAdd something newAdd something new2.status: stalehttps://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.mdhttps://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md6.topic: documentationMeta-discussion about documentation and its workflowMeta-discussion about documentation and its workflow