[doc] engine-table: link module documentation if it exists

1 files changed, 19 insertions, 0 deletions

diff --git a/docs/conf.py b/docs/conf.py
index a319762e2..560e3daf8 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -58,6 +58,25 @@ jinja_filters = {
     )
 }
 
+# Let the Jinja template in configured_engines.rst access documented_modules
+# to automatically link documentation for modules if it exists.
+def setup(app):
+    ENGINES_DOCNAME = 'admin/engines/configured_engines'
+
+    def before_read_docs(app, env, docnames):
+        assert ENGINES_DOCNAME in docnames
+        docnames.remove(ENGINES_DOCNAME)
+        docnames.append(ENGINES_DOCNAME)
+        # configured_engines must come last so that sphinx already has
+        # discovered the python module documentations
+
+    def source_read(app, docname, source):
+        if docname == ENGINES_DOCNAME:
+            jinja_contexts['searx']['documented_modules'] = app.env.domains['py'].modules
+
+    app.connect('env-before-read-docs', before_read_docs)
+    app.connect('source-read', source_read)
+
 # usage::   lorem :patch:`f373169` ipsum
 extlinks = {}