From fa47df617443b6bd7be0fe0239418c241df146c3 Mon Sep 17 00:00:00 2001 From: Graham Christensen Date: Thu, 4 Jul 2019 09:06:39 -0400 Subject: [PATCH] doc: move parameters to an XML file --- doc/Makefile | 8 ++++---- doc/default.nix | 15 --------------- doc/doc-support/default.nix | 22 ++++++++++++++++++++++ doc/doc-support/parameters.xml | 14 ++++++++++++++ 4 files changed, 40 insertions(+), 19 deletions(-) create mode 100644 doc/doc-support/parameters.xml diff --git a/doc/Makefile b/doc/Makefile index 4bf33f7dd43b..e7ca31b20d71 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -30,10 +30,10 @@ validate: manual-full.xml doc-support/result out/html/index.html: doc-support/result manual-full.xml style.css highlightjs mkdir -p out/html - xsltproc ${xsltFlags} \ + xsltproc \ --nonet --xinclude \ --output $@ \ - doc-support/result/xsl/docbook/xhtml/docbook.xsl \ + doc-support/result/xhtml.xsl \ ./manual-full.xml mkdir -p out/html/highlightjs/ @@ -48,9 +48,9 @@ out/html/index.html: doc-support/result manual-full.xml style.css highlightjs out/epub/manual.epub: manual-full.xml mkdir -p out/epub/scratch - xsltproc ${xsltFlags} --nonet \ + xsltproc --nonet \ --output out/epub/scratch/ \ - doc-support/result/xsl/docbook/epub/docbook.xsl \ + doc-support/result/epub.xsl \ ./manual-full.xml cp ./overrides.css out/epub/scratch/OEBPS diff --git a/doc/default.nix b/doc/default.nix index 971c60b35c2a..d9051167dee5 100644 --- a/doc/default.nix +++ b/doc/default.nix @@ -9,21 +9,6 @@ in pkgs.stdenv.mkDerivation { src = ./.; - # Hacking on these variables? Make sure to close and open - # nix-shell between each test, maybe even: - # $ nix-shell --run "make clean all" - # otherwise they won't reapply :) - xsltFlags = lib.concatStringsSep " " [ - "--param section.autolabel 1" - "--param section.label.includes.component.label 1" - "--stringparam html.stylesheet 'style.css overrides.css highlightjs/mono-blue.css'" - "--stringparam html.script './highlightjs/highlight.pack.js ./highlightjs/loader.js'" - "--param xref.with.number.and.title 1" - "--param toc.section.depth 3" - "--stringparam admon.style ''" - "--stringparam callout.graphics.extension .svg" - ]; - postPatch = '' ln -s ${doc-support} ./doc-support/result ''; diff --git a/doc/doc-support/default.nix b/doc/doc-support/default.nix index c8be039fa7e0..53990b677196 100644 --- a/doc/doc-support/default.nix +++ b/doc/doc-support/default.nix @@ -3,6 +3,26 @@ let locationsXml = import ./lib-function-locations.nix { inherit pkgs nixpkgs; }; functionDocs = import ./lib-function-docs.nix { inherit locationsXml pkgs; }; version = pkgs.lib.version; + + epub-xsl = pkgs.writeText "epub.xsl" '' + + + + + + ''; + + xhtml-xsl = pkgs.writeText "xhtml.xsl" '' + + + + + + ''; in pkgs.runCommand "doc-support" {} '' mkdir result @@ -13,6 +33,8 @@ in pkgs.runCommand "doc-support" {} ln -s ${pkgs.docbook5}/xml/rng/docbook/docbook.rng ./docbook.rng ln -s ${pkgs.docbook_xsl_ns}/xml/xsl ./xsl + ln -s ${epub-xsl} ./epub.xsl + ln -s ${xhtml-xsl} ./xhtml.xsl ln -s ${../../nixos/doc/xmlformat.conf} ./xmlformat.conf ln -s ${pkgs.documentation-highlighter} ./highlightjs diff --git a/doc/doc-support/parameters.xml b/doc/doc-support/parameters.xml new file mode 100644 index 000000000000..bc13e2b70dec --- /dev/null +++ b/doc/doc-support/parameters.xml @@ -0,0 +1,14 @@ + + + + + + + + + + + +