summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/_themes/searx/static/searx.css29
-rw-r--r--docs/admin/engines.rst2
-rw-r--r--docs/admin/plugins.rst2
-rw-r--r--docs/conf.py10
-rw-r--r--docs/dev/makefile.rst29
-rw-r--r--docs/dev/reST.rst19
-rw-r--r--docs/user/conf.py2
-rw-r--r--docs/user/own-instance.rst6
8 files changed, 58 insertions, 41 deletions
diff --git a/docs/_themes/searx/static/searx.css b/docs/_themes/searx/static/searx.css
index 0f2eff728..ae742a4e0 100644
--- a/docs/_themes/searx/static/searx.css
+++ b/docs/_themes/searx/static/searx.css
@@ -138,32 +138,3 @@ caption {
caption-side: top;
text-align: left;
}
-
-/* bugs since sphinx 3.1
-
-See sphinx-doc project, PR 7838 & 7484 with elementary patch to the basic CSS:
-
-- https://github.com/sphinx-doc/sphinx/issues/7838#issuecomment-646009605
-- https://github.com/sphinx-doc/sphinx/pull/7484#issuecomment-646058972
-
-*/
-
-li > p:first-child {
- margin-top: 0;
-}
-
-li > p:last-child {
- margin-bottom: 0;
-}
-
-div.admonition dl {
- margin-bottom: 0;
-}
-
-div.sidebar {
- clear: none;
-}
-
-div.admonition, div.topic, pre {
- clear: none;
-}
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/makefile.rst b/docs/dev/makefile.rst
index 699729a28..c43855617 100644
--- a/docs/dev/makefile.rst
+++ b/docs/dev/makefile.rst
@@ -150,6 +150,35 @@ Documentation <contrib docs>` section. If you want to edit the documentation
read our :ref:`make docs-live` section. If you are working in your own brand,
adjust your :ref:`Makefile setup <makefile setup>`.
+.. _make books:
+
+``make books/{name}.html books/{name}.pdf``
+===========================================
+
+.. _intersphinx: https://www.sphinx-doc.org/en/stable/ext/intersphinx.html
+.. _XeTeX: https://tug.org/xetex/
+
+.. sidebar:: info
+
+ To build PDF a XeTeX_ is needed, see :ref:`buildhosts`.
+
+
+The ``books/{name}.*`` targets are building *books*. A *book* is a
+sub-directory containing a ``conf.py`` file. One example is the user handbook
+which can deployed separately (:origin:`docs/user/conf.py`). Such ``conf.py``
+do inherit from :origin:`docs/conf.py` and overwrite values to fit *book's*
+needs.
+
+With the help of Intersphinx_ (:ref:`reST smart ref`) the links to searx’s
+documentation outside of the book will be bound by the object inventory of
+``DOCS_URL``. Take into account that URLs will be picked from the inventary at
+documentation's build time.
+
+Use ``make docs-help`` to see which books available:
+
+.. program-output:: bash -c "cd ..; make --no-print-directory docs-help"
+ :ellipsis: 0,-6
+
.. _make gh-pages:
diff --git a/docs/dev/reST.rst b/docs/dev/reST.rst
index 963378748..39cd9f671 100644
--- a/docs/dev/reST.rst
+++ b/docs/dev/reST.rst
@@ -319,6 +319,9 @@ To list all anchors of the inventory (e.g. ``python``) use:
.. code:: sh
$ python -m sphinx.ext.intersphinx https://docs.python.org/3/objects.inv
+ ...
+ $ python -m sphinx.ext.intersphinx https://searx.github.io/searx/objects.inv
+ ...
Literal blocks
==============
@@ -1286,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
+ },
}
diff --git a/docs/user/conf.py b/docs/user/conf.py
index 53ade4b63..da2e27533 100644
--- a/docs/user/conf.py
+++ b/docs/user/conf.py
@@ -4,6 +4,8 @@
project = 'Searx User-HB'
version = release = VERSION_STRING
+intersphinx_mapping['searx'] = (DOCS_URL, None)
+
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
diff --git a/docs/user/own-instance.rst b/docs/user/own-instance.rst
index af415b61d..bb4c5d524 100644
--- a/docs/user/own-instance.rst
+++ b/docs/user/own-instance.rst
@@ -56,9 +56,9 @@ results.
I see. What about private instances?
------------------------------------
-If users run their own instances, everything is in their control: the source
-code, logging settings and private data. Unknown instance administrators do not
-have to be trusted.
+If users run their :ref:`own instances <installation>`, everything is in their
+control: the source code, logging settings and private data. Unknown instance
+administrators do not have to be trusted.
Furthermore, as the default settings of their instance is editable, there is no
need to use cookies to tailor searx to their needs. So preferences will not be