diff --git a/doc.nix b/doc.nix index 99778b9..beb36dd 100644 --- a/doc.nix +++ b/doc.nix @@ -39,7 +39,7 @@ stdenv.mkDerivation { ]; buildPhase = '' - cat ${json} | fennel --correlate doc/parse-options.fnl > doc/modules-generated.inc.rst + cat ${json} | fennel --correlate doc/parse-options.fnl > doc/module-options-generated.inc.rst cat ${json} | fennel --correlate doc/parse-options-outputs.fnl > doc/outputs-generated.inc.rst cp ${(import ./doc/hardware.nix)} doc/hardware.rst make -C doc html diff --git a/doc/Makefile b/doc/Makefile index 237a512..4d7dcd6 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -5,15 +5,15 @@ DOCS=\ index \ installation \ intro \ - modules \ - outputs \ hardware \ + module-options-generated.inc \ + outputs-generated.inc \ tutorial +%.adoc: %.rst + pandoc -f rst -t asciidoc $< | sed -E -e 's/^(=*) /=\1 /g' > $@ + hardware.adoc: hardware.nix - pandoc -f rst -t asciidoc -o $@ hardware.rst - # sections in an appendix need to start at === - sed -E -i.bak -e 's/^(=*) /=\1 /g' hardware.adoc html: Makefile $(patsubst %,%.adoc,$(DOCS)) asciidoctor -D _build -d book index.adoc diff --git a/doc/index.adoc b/doc/index.adoc index b8f3aa4..081c3c9 100644 --- a/doc/index.adoc +++ b/doc/index.adoc @@ -36,3 +36,22 @@ the safe bet, or the Linksys E8450 which seems popular in the OpenWrt community. include::hardware.adoc[] + +[appendix] += Module and service options + +include::module-options-generated.inc.adoc[] + +[appendix] += Outputs + +*Outputs* are artefacts that can be installed somehow on a +target device, or "installers" which run on the target device to perform +the installation. + +There are different outputs because different target devices need +different artefacts, or have different ways to get that artefact +installed. The options available for a particular device are described +in the section for that device. + +include::outputs-generated.inc.adoc[] diff --git a/doc/outputs.adoc b/doc/outputs.adoc index 677cb38..f5d2a94 100644 --- a/doc/outputs.adoc +++ b/doc/outputs.adoc @@ -8,3 +8,5 @@ There are different outputs because different target devices need different artefacts, or have different ways to get that artefact installed. The options available for a particular device are described in the section for that device. + +include::outputs-generated.inc.adoc[]