add appendices for modules/service/outputs generated doc
This commit is contained in:
parent
eb16a35ff3
commit
2f092e126a
2
doc.nix
2
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
|
||||
|
10
doc/Makefile
10
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
|
||||
|
@ -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[]
|
||||
|
@ -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[]
|
||||
|
Loading…
Reference in New Issue
Block a user