libremiami-search/docs/dev
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>
2019-12-12 19:20:56 +01:00
..
install doc: installation.rst improve reST markup 2019-12-12 13:30:12 +01:00
contribution_guide.rst doc: proofread of the all reST sources (no content change) 2019-12-12 19:20:56 +01:00
engine_overview.rst doc: proofread of the all reST sources (no content change) 2019-12-12 19:20:56 +01:00
plugins.rst doc: proofread of the all reST sources (no content change) 2019-12-12 19:20:56 +01:00
quickstart.rst doc: proofread of the all reST sources (no content change) 2019-12-12 19:20:56 +01:00
search_api.rst doc: proofread of the all reST sources (no content change) 2019-12-12 19:20:56 +01:00
translation.rst doc: proofread of the all reST sources (no content change) 2019-12-12 19:20:56 +01:00