Commit Graph

9 Commits (b1e90cff23eae2181d2b430e77471f488947d1a9)

Author SHA1 Message Date
Markus Heiser d1154202bc doc: add reST templating // incl. generic engine tabe
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser e9fff4fde6 doc: proofread of the all reST sources (no content change)
Normalize reST sources with best practice and KISS in mind.

to name a few points:

- simplify reST tables
- make use of ``literal`` markup for monospace rendering
- fix code-blocks for better rendering in HTML
- normalize section header markup
- limit all lines to a maximum of 79 characters
- add option -H to the sudo command used in code blocks
- drop useless indentation of lists
- ...

[1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser af2cae6d1d doc: make use of sphinx.ext.extlinks & sphinx.ext.intersphinx
- add sphinx extensions
- patch documentation to make use of

These modules help to simplify the reST markup of external references.  BTW it
helps to write more readable reST and form custom brands.

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Noémi Ványi 021e1da4c9 add post about introducing offline engines 5 years ago
Noémi Ványi 50f25193c1 engine overview fix torrent table 8 years ago
Noémi Ványi c2cf46092e docs: fix typos based on #653 8 years ago
Noemi Vanyi 240802003e [doc] fix small mistakes in engine overview 9 years ago
Noemi Vanyi ae69a58089 [doc] grammar & format fixes in engine overview 9 years ago
Adam Tauber 11d6d80d88 [doc] engines overview added 9 years ago