docs: generate the list of options

To generate the list of options, we need to generate and commit a rst
file to make all files available for ReadTheDoc.

An Hydra test ensures this generated file is up-to-date. If it is not
up-to-date, the error message explains the user how to generate it:
the user just needs to run `nix-shell --run generate-rst-options`.
This commit is contained in:
Antoine Eiche 2021-07-14 10:06:58 +02:00 committed by lewo
parent 9578dbac69
commit 4d087532b6
5 changed files with 1247 additions and 3 deletions

View file

@ -46,6 +46,13 @@ documentation:
$ make html
$ firefox ./_build/html/index.html
Note if you modify some NixOS mailserver options, you would also need
to regenerate the ``options.rst`` file:
::
$ nix-shell --run generate-rst-options
Nixops
------

View file

@ -17,6 +17,7 @@ Welcome to NixOS Mailserver's documentation!
howto-develop
faq
release-notes
options
.. toctree::
:maxdepth: 1

1132
docs/options.rst Normal file

File diff suppressed because it is too large Load diff