diff options
| author | Markus Heiser <markus.heiser@darmarit.de> | 2019-12-12 19:20:56 +0100 |
|---|---|---|
| committer | Markus Heiser <markus.heiser@darmarit.de> | 2019-12-12 19:20:56 +0100 |
| commit | e9fff4fde6d7a8bec3fae087d2afe1fce2145f22 (patch) | |
| tree | 4714c7130b9b6ae90ef53084106b23b967b4150b /docs/conf.py | |
| parent | 0011890043a65b318a32134ab4029f3c74bc07ee (diff) | |
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>
Diffstat (limited to 'docs/conf.py')
| -rw-r--r-- | docs/conf.py | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/conf.py b/docs/conf.py index ee60e46e3..5186d0123 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,12 +20,16 @@ master_doc = "index" source_suffix = '.rst' # usage:: lorem :patch:`f373169` ipsum - extlinks = {} + +# upstream links +extlinks['wiki'] = ('https://github.com/asciimoo/searx/wiki/%s', ' ') +extlinks['pull'] = ('https://github.com/asciimoo/searx/pull/%s', 'PR ') + +# links to custom brand extlinks['origin'] = (GIT_URL + '/blob/master/%s', 'git://') extlinks['patch'] = (GIT_URL + '/commit/%s', '#') extlinks['search'] = (SEARX_URL + '/%s', '#') -extlinks['wiki'] = ('https://github.com/asciimoo/searx/wiki/%s', ' ') extensions = [ 'sphinx.ext.extlinks', |