document installation methods (only vmroot yet)
This commit is contained in:
parent
7d5c7b9b44
commit
5729cfb4a7
4 changed files with 21 additions and 0 deletions
1
ci.nix
1
ci.nix
|
@ -47,6 +47,7 @@ let
|
||||||
src = ./.;
|
src = ./.;
|
||||||
buildPhase = ''
|
buildPhase = ''
|
||||||
cat ${json} | fennel --correlate doc/parse-options.fnl > doc/modules-generated.rst
|
cat ${json} | fennel --correlate doc/parse-options.fnl > doc/modules-generated.rst
|
||||||
|
cat ${json} | fennel --correlate doc/parse-options-outputs.fnl system.outputs.vmroot > doc/installers-generated.rst
|
||||||
cp ${(import ./doc/hardware.nix)} doc/hardware.rst
|
cp ${(import ./doc/hardware.nix)} doc/hardware.rst
|
||||||
make -C doc html
|
make -C doc html
|
||||||
'';
|
'';
|
||||||
|
|
|
@ -12,6 +12,7 @@ Liminix
|
||||||
development
|
development
|
||||||
modules
|
modules
|
||||||
hardware
|
hardware
|
||||||
|
installers
|
||||||
|
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
|
|
8
doc/installers.rst
Normal file
8
doc/installers.rst
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
Installers
|
||||||
|
##########
|
||||||
|
|
||||||
|
There are a number of different routes to getting
|
||||||
|
Liminix onto devices, and which one you should use
|
||||||
|
(or are able to use) varies according to the device.
|
||||||
|
|
||||||
|
.. include:: installers-generated.rst
|
11
doc/parse-options-outputs.fnl
Normal file
11
doc/parse-options-outputs.fnl
Normal file
|
@ -0,0 +1,11 @@
|
||||||
|
(local yaml (require :lyaml))
|
||||||
|
|
||||||
|
;; (local { : view } (require :fennel))
|
||||||
|
|
||||||
|
(local outputs (collect [k v (ipairs arg)]
|
||||||
|
(values v true)))
|
||||||
|
|
||||||
|
(each [_ option (ipairs (yaml.load (io.read "*a")))]
|
||||||
|
(when (. outputs option.name)
|
||||||
|
(print (.. ".. _" option.name) "\n")
|
||||||
|
(print option.description)))
|
Loading…
Reference in a new issue