diff options
| author | Vincent Ambo <mail@tazj.in> | 2018-12-30 01:10:19 +0100 |
|---|---|---|
| committer | Frederik Rietdijk <freddyrietdijk@fridh.nl> | 2019-01-04 11:28:27 +0100 |
| commit | 0c99dac49735d3a7c20d231c4d7b1dc057bc81df (patch) | |
| tree | a45072f55fc1c27189c95285d17512c3632a7bb3 /doc/default.nix | |
| parent | eab0c3258ff90ee1023b2488e2237b315d8d486b (diff) | |
| download | nixpkgs-0c99dac49735d3a7c20d231c4d7b1dc057bc81df.tar nixpkgs-0c99dac49735d3a7c20d231c4d7b1dc057bc81df.tar.gz nixpkgs-0c99dac49735d3a7c20d231c4d7b1dc057bc81df.tar.bz2 nixpkgs-0c99dac49735d3a7c20d231c4d7b1dc057bc81df.tar.lz nixpkgs-0c99dac49735d3a7c20d231c4d7b1dc057bc81df.tar.xz nixpkgs-0c99dac49735d3a7c20d231c4d7b1dc057bc81df.tar.zst nixpkgs-0c99dac49735d3a7c20d231c4d7b1dc057bc81df.zip | |
doc: Add automatic generation of library function documentation
Modifies the build process of the manual to invoke nixdoc automatically to generate XML files with function documentation. Currently documentation is present for five of the files in `lib/`. To add another file to the generated docs, both `doc/functions/library.xml` and `doc/lib-function-docs.nix` must be updated.
Diffstat (limited to 'doc/default.nix')
| -rw-r--r-- | doc/default.nix | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/default.nix b/doc/default.nix index 98b4b92be52..7ceaec28af3 100644 --- a/doc/default.nix +++ b/doc/default.nix @@ -2,8 +2,8 @@ let lib = pkgs.lib; locationsXml = import ./lib-function-locations.nix { inherit pkgs nixpkgs; }; -in -pkgs.stdenv.mkDerivation { + functionDocs = import ./lib-function-docs.nix { inherit locationsXml pkgs; }; +in pkgs.stdenv.mkDerivation { name = "nixpkgs-manual"; buildInputs = with pkgs; [ pandoc libxml2 libxslt zip jing xmlformat ]; @@ -32,6 +32,7 @@ pkgs.stdenv.mkDerivation { postPatch = '' rm -rf ./functions/library/locations.xml ln -s ${locationsXml} ./functions/library/locations.xml + ln -s ${functionDocs} ./functions/library/generated echo ${lib.version} > .version ''; |