summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2021-11-18 17:27:49 +0100
committerMarkus Heiser <markus.heiser@darmarit.de>2021-11-18 17:27:49 +0100
commit2cc24068597830c778b339f096e757678337d22b (patch)
tree49599ca58adca67a834af61b5a0e66d14d1a1d9b /docs
parent08d66804140f860837c9a03d2c0bdedd78b6cd14 (diff)
[mod] doc - in sidebar, add links to the reST sources
Offer links to the reST sources (aka) html_show_sourcelink [1]. Links to the reST source are sometimes very helpful, especially in our resT-Primer [2] :) [1] https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_show_sourcelink [2] https://searxng.github.io/searxng/dev/reST.html Related-to: https://github.com/pallets/pallets-sphinx-themes/issues/32 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/conf.py b/docs/conf.py
index eb359890..47cdaa3f 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -130,13 +130,13 @@ if CONTACT_URL:
html_context["project_links"].append(ProjectLink("Contact", CONTACT_URL))
html_sidebars = {
- "**": ["project.html", "relations.html", "searchbox.html"],
+ "**": ["project.html", "relations.html", "searchbox.html", "sourcelink.html"],
}
singlehtml_sidebars = {"index": ["project.html", "localtoc.html"]}
html_static_path = ["static"]
html_logo = "static/img/searx_logo_small.png"
html_title = "SearXNG Documentation ({})".format(VERSION_STRING)
-html_show_sourcelink = False
+html_show_sourcelink = True
# LaTeX ----------------------------------------------------------------