From eb1b5289d5da742473dd412e83abe35406da5fa5 Mon Sep 17 00:00:00 2001 From: Alexandre Flament Date: Mon, 21 Dec 2020 09:53:41 +0100 Subject: [PATCH] [mod] documentation: change the jinja context doesn't depend on searx.webapp Before this commit, in the documentation, the jinja context is 'webapp' and contains the global variable in the searx.webapp module. This commit changes this to include only the mandatory variables to build the documentation. --- docs/admin/engines.rst | 2 +- docs/admin/plugins.rst | 2 +- docs/conf.py | 10 ++++++++-- docs/dev/reST.rst | 16 +++++++++++----- 4 files changed, 21 insertions(+), 9 deletions(-) diff --git a/docs/admin/engines.rst b/docs/admin/engines.rst index 0ec86a614..3ad206303 100644 --- a/docs/admin/engines.rst +++ b/docs/admin/engines.rst @@ -46,7 +46,7 @@ Show errors **DE** .. _configured engines: -.. jinja:: webapp +.. jinja:: searx .. flat-table:: Engines configured at built time (defaults) :header-rows: 1 diff --git a/docs/admin/plugins.rst b/docs/admin/plugins.rst index 4ed9066fd..d97b3dada 100644 --- a/docs/admin/plugins.rst +++ b/docs/admin/plugins.rst @@ -14,7 +14,7 @@ Configuration defaults (at built time): .. _configured plugins: -.. jinja:: webapp +.. jinja:: searx .. flat-table:: Plugins configured at built time (defaults) :header-rows: 1 diff --git a/docs/conf.py b/docs/conf.py index d6fde9bec..0c07761a8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -27,9 +27,15 @@ numfig = True exclude_patterns = ['build-templates/*.rst'] -from searx import webapp +import searx.search +import searx.engines +import searx.plugins +searx.search.initialize() jinja_contexts = { - 'webapp': dict(**webapp.__dict__), + 'searx': { + 'engines': searx.engines.engines, + 'plugins': searx.plugins.plugins + }, } # usage:: lorem :patch:`f373169` ipsum diff --git a/docs/dev/reST.rst b/docs/dev/reST.rst index 8adf4115e..39cd9f671 100644 --- a/docs/dev/reST.rst +++ b/docs/dev/reST.rst @@ -1289,15 +1289,21 @@ build chapter: :ref:`engines generic`. Below the jinja directive from the :language: reST :start-after: .. _configured engines: -The context for the template is selected in the line ``.. jinja:: webapp``. In -sphinx's build configuration (:origin:`docs/conf.py`) the ``webapp`` context -points to the name space of the python module: ``webapp``. +The context for the template is selected in the line ``.. jinja:: searx``. In +sphinx's build configuration (:origin:`docs/conf.py`) the ``searx`` context +contains the ``engines`` and ``plugins``. .. code:: py - from searx import webapp + import searx.search + import searx.engines + import searx.plugins + searx.search.initialize() jinja_contexts = { - 'webapp': dict(**webapp.__dict__) + 'searx': { + 'engines': searx.engines.engines, + 'plugins': searx.plugins.plugins + }, }