doc: add content to reST primer (WIP) // linuxdoc

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>

docs/_themes/searx/static/searx.css

@@ -29,6 +29,14 @@ p.sidebar-title, .sidebar p {
 }
 
 
+div.admonition,
+div.topic {
+  background-color: #fafafa;
+  margin: 8px 0px;
+  padding: 1em;
+  border: none;
+}
+
 /* admonitions with (rendered) reST markup examples (:class: rst-example)
  *
  * .. admonition:: title of the example

docs/conf.py

@@ -20,6 +20,7 @@ highlight_language = 'none'
 
 master_doc = "index"
 source_suffix = '.rst'
+numfig = True
 
 # usage::   lorem :patch:`f373169` ipsum
 extlinks = {}
@@ -35,6 +36,8 @@ extlinks['search'] = (SEARX_URL + '/%s', '#')
 extlinks['docs'] = (DOCS_URL + '/%s', 'docs: ')
 extlinks['pypi'] = ('https://pypi.org/project/%s', 'PyPi: ')
 extlinks['man'] = ('https://manpages.debian.org/jump?q=%s', '')
+#extlinks['role'] = (
+#    'https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-%s', '')
 extlinks['duref'] = (
     'http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#%s', '')
 extlinks['durole'] = (
@@ -49,6 +52,12 @@ extensions = [
     "sphinx.ext.intersphinx",
     "pallets_sphinx_themes",
     "sphinx_issues", # https://github.com/sloria/sphinx-issues/blob/master/README.rst
+    'linuxdoc.rstFlatTable',    # Implementation of the 'flat-table' reST-directive.
+    'linuxdoc.rstKernelDoc',    # Implementation of the 'kernel-doc' reST-directive.
+    'linuxdoc.kernel_include',  # Implementation of the 'kernel-include' reST-directive.
+    'linuxdoc.manKernelDoc',    # Implementation of the 'kernel-doc-man' builder
+    'linuxdoc.cdomain',         # Replacement for the sphinx c-domain.
+    'linuxdoc.kfigure',         # Sphinx extension which implements scalable image handling.
 ]
 
 intersphinx_mapping = {
@@ -56,6 +65,8 @@ intersphinx_mapping = {
     "flask": ("https://flask.palletsprojects.com/", None),
     # "werkzeug": ("https://werkzeug.palletsprojects.com/", None),
     "jinja": ("https://jinja.palletsprojects.com/", None),
+    "linuxdoc" : ("https://return42.github.io/linuxdoc/", None),
+    "sphinx" : ("https://www.sphinx-doc.org/en/master/", None),
 }
 
 issues_github_path = "asciimoo/searx"

docs/dev/hello.dot

+graph G {
+      Hello -- World
+}

docs/dev/svg_image.svg

+<?xml version="1.0" encoding="UTF-8"?>
+<!-- originate: https://commons.wikimedia.org/wiki/File:Variable_Resistor.svg -->
+<svg xmlns="http://www.w3.org/2000/svg"
+	version="1.1" baseProfile="full"
+	width="70px" height="40px" viewBox="0 0 700 400">
+	<line x1="0" y1="200" x2="700" y2="200" stroke="black" stroke-width="20px"/>
+	<rect x="100" y="100" width="500" height="200" fill="white" stroke="black" stroke-width="20px"/>
+	<line x1="180" y1="370" x2="500" y2="50" stroke="black" stroke-width="15px"/>
+	<polygon points="585 0 525 25 585 50" transform="rotate(135 525 25)"/>
+</svg>

requirements-dev.txt

@@ -11,3 +11,4 @@ transifex-client==0.12.2
 unittest2==1.1.0
 zope.testrunner==4.5.1
 selenium==3.141.0
+linuxdoc @ git+http://github.com/return42/linuxdoc.git