* Generate DocBook documentation on the available options from the Nix
expression. svn path=/nixos/trunk/; revision=7764
This commit is contained in:
parent
5d883cbb85
commit
3034daabb7
20
doc/manual/Makefile
Normal file
20
doc/manual/Makefile
Normal file
|
@ -0,0 +1,20 @@
|
||||||
|
XMLLINT = xmllint --catalogs
|
||||||
|
XSLTPROC = xsltproc --catalogs \
|
||||||
|
--param section.autolabel 1 \
|
||||||
|
--param section.label.includes.component.label 1 \
|
||||||
|
--param html.stylesheet \'style.css\' \
|
||||||
|
--param xref.with.number.and.title 1 \
|
||||||
|
--param toc.section.depth 3 \
|
||||||
|
--param admon.style \'\' \
|
||||||
|
--param callout.graphics.extension \'.gif\'
|
||||||
|
|
||||||
|
options.html: options-db.xml
|
||||||
|
$(XSLTPROC) --nonet --xinclude --output $@ \
|
||||||
|
$(docbookxsl)/html/docbook.xsl options-db.xml
|
||||||
|
|
||||||
|
options-db.xml: options.xml options-to-docbook.xsl
|
||||||
|
xsltproc -o options-db.xml options-to-docbook.xsl options.xml
|
||||||
|
|
||||||
|
options.xml: ../../system/options.nix
|
||||||
|
echo 'import ../../system/options.nix {pkgs = import ../../pkgs/top-level/all-packages.nix {};}' | \
|
||||||
|
nix-instantiate --eval-only --xml --strict - > options.xml || (rm options.xml && false)
|
45
doc/manual/options-to-docbook.xsl
Normal file
45
doc/manual/options-to-docbook.xsl
Normal file
|
@ -0,0 +1,45 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
|
||||||
|
<xsl:stylesheet version="1.0"
|
||||||
|
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
|
||||||
|
xmlns:str="http://exslt.org/strings"
|
||||||
|
xmlns="http://docbook.org/ns/docbook"
|
||||||
|
extension-element-prefixes="str"
|
||||||
|
>
|
||||||
|
|
||||||
|
<xsl:output method='xml' encoding="UTF-8" />
|
||||||
|
|
||||||
|
<xsl:template match="/expr/list">
|
||||||
|
|
||||||
|
<chapter>
|
||||||
|
<title>List of Options</title>
|
||||||
|
|
||||||
|
<variablelist>
|
||||||
|
|
||||||
|
<xsl:for-each select="attrs">
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term>
|
||||||
|
<option>
|
||||||
|
<xsl:for-each select="attr[@name = 'name']/list/string">
|
||||||
|
<xsl:value-of select="@value" />
|
||||||
|
<xsl:if test="position() != last()">.</xsl:if>
|
||||||
|
</xsl:for-each>
|
||||||
|
</option>
|
||||||
|
</term>
|
||||||
|
|
||||||
|
<listitem><para>
|
||||||
|
<xsl:value-of select="attr[@name = 'description']/string/@value" />
|
||||||
|
</para></listitem>
|
||||||
|
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
</xsl:for-each>
|
||||||
|
|
||||||
|
</variablelist>
|
||||||
|
|
||||||
|
</chapter>
|
||||||
|
|
||||||
|
</xsl:template>
|
||||||
|
|
||||||
|
</xsl:stylesheet>
|
Loading…
Reference in a new issue