Skynet/misc_nixos-mailserver
7
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

docs: use MarkDown for option docs

Browse source
This commit is contained in:
Naïm Favier 2022-11-30 22:30:45 +01:00
parent bc667fb6af
commit 4fcab839d7
No known key found for this signature in database
GPG key ID: 95AFCE8211908325
13 changed files with 1403 additions and 1487 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/howto-develop.rst
View file

@ -30,8 +30,8 @@ run tests manually. For instance:
Contributing to the documentation
---------------------------------
The documentation is written in RST, build with Sphinx and published
by `Read the Docs <https://readthedocs.org/>`_.
The documentation is written in RST (except option documentation which is in MarkDown),
built with Sphinx and published by `Read the Docs <https://readthedocs.org/>`_.
For the syntax, see `RST/Sphinx Cheatsheet
<https://sphinx-tutorial.readthedocs.io/cheatsheet/>`_.
@ -47,11 +47,11 @@ documentation:
$ firefox ./_build/html/index.html
Note if you modify some NixOS mailserver options, you would also need
to regenerate the ``options.rst`` file:
to regenerate the ``options.md`` file:
::
$ nix-shell --run generate-rst-options
$ nix-shell --run generate-options
Nixops
------