Browse Source

Merge pull request #628 from not-my-profile/sort-engines

[doc] engine-table: sort by Disabled and Name
Markus Heiser 3 years ago
parent
commit
5951bb5488
3 changed files with 5 additions and 2 deletions
  1. 1 1
      docs/admin/engines/configured_engines.rst
  2. 3 0
      docs/conf.py
  3. 1 1
      requirements-dev.txt

+ 1 - 1
docs/admin/engines/configured_engines.rst

@@ -37,7 +37,7 @@ Explanation of the :ref:`general engine configuration` shown in the table
         - Safe search
         - Time range
 
-      {% for name, mod in engines %}
+      {% for name, mod in engines | sort_engines %}
 
       * - `{{name}} <{{mod.about and mod.about.website}}>`_
         - ``!{{mod.shortcut}}``

+ 3 - 0
docs/conf.py

@@ -49,6 +49,9 @@ jinja_contexts = {
         },
     },
 }
+jinja_filters = {
+    'sort_engines': lambda engines: sorted(engines, key=lambda engine: (engine[1].disabled, engine[0]))
+}
 
 # usage::   lorem :patch:`f373169` ipsum
 extlinks = {}

+ 1 - 1
requirements-dev.txt

@@ -9,7 +9,7 @@ twine==3.7.1
 Pallets-Sphinx-Themes==2.0.2
 Sphinx==4.3.1
 sphinx-issues==1.2.0
-sphinx-jinja==1.1.1
+sphinx-jinja==1.2.1
 sphinx-tabs==3.2.0
 sphinxcontrib-programoutput==0.17
 sphinx-autobuild==2021.3.14