Browse Source

doc: add plugin section to admin section (template)

- Plugins configured at built time (defaults)

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Markus Heiser 5 years ago
parent
commit
90174e215c
3 changed files with 46 additions and 0 deletions
  1. 1 0
      docs/admin/index.rst
  2. 39 0
      docs/admin/plugins.rst
  3. 6 0
      docs/dev/plugins.rst

+ 1 - 0
docs/admin/index.rst

@@ -11,3 +11,4 @@ Administrator documentation
    filtron
    morty
    engines
+   plugins

+ 39 - 0
docs/admin/plugins.rst

@@ -0,0 +1,39 @@
+.. _plugins generic:
+
+===============
+Plugins builtin
+===============
+
+.. sidebar:: Further reading ..
+
+   - :ref:`dev plugin`
+
+Configuration defaults (at built time):
+
+:DO: Default on
+
+.. _configured plugins:
+
+.. jinja:: webapp
+
+   .. flat-table:: Plugins configured at built time (defaults)
+      :header-rows: 1
+      :stub-columns: 1
+      :widths: 3 1 9
+
+      * - Name
+        - DO
+        - Description
+
+          JS & CSS dependencies
+
+      {% for plgin in plugins %}
+
+      * - {{plgin.name}}
+        - {{(plgin.default_on and "y") or ""}}
+        - {{plgin.description}}
+
+          {% for dep in (plgin.js_dependencies + plgin.css_dependencies) %}
+          | ``{{dep}}`` {% endfor %}
+
+      {% endfor %}

+ 6 - 0
docs/dev/plugins.rst

@@ -1,7 +1,13 @@
+.. _dev plugin:
+
 =======
 Plugins
 =======
 
+.. sidebar:: Further reading ..
+
+   - :ref:`plugins generic`
+
 Plugins can extend or replace functionality of various components of searx.
 
 Example plugin