From 876988a34f76988fc7375caace382480f122f940 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Sat, 11 Jan 2020 12:49:02 +0100 Subject: docs: add Sphinx-doc extension sphinxcontrib.programoutput - https://github.com/NextThought/sphinxcontrib-programoutput Signed-off-by: Markus Heiser --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index af255e230..8c5f6b311 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -61,6 +61,7 @@ extensions = [ "pallets_sphinx_themes", "sphinx_issues", # https://github.com/sloria/sphinx-issues/blob/master/README.rst "sphinxcontrib.jinja", # https://github.com/tardyp/sphinx-jinja + "sphinxcontrib.programoutput", # https://github.com/NextThought/sphinxcontrib-programoutput 'linuxdoc.rstFlatTable', # Implementation of the 'flat-table' reST-directive. 'linuxdoc.kfigure', # Sphinx extension which implements scalable image handling. "sphinx_tabs.tabs", # https://github.com/djungelorm/sphinx-tabs -- cgit v1.2.3 From a5eefea61d8a2287a0065f79cbe12d4e415be743 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Tue, 4 Feb 2020 13:26:43 +0100 Subject: docs: fix extlink 'origin' to use GIT_BRANCH env Signed-off-by: Markus Heiser --- docs/conf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 8c5f6b311..8b4276c18 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -5,6 +5,7 @@ from searx.version import VERSION_STRING from pallets_sphinx_themes import ProjectLink GIT_URL = os.environ.get("GIT_URL", "https://github.com/asciimoo/searx") +GIT_BRANCH =os.environ.get("GIT_BRANCH", "master") SEARX_URL = os.environ.get("SEARX_URL", "https://searx.me") DOCS_URL = os.environ.get("DOCS_URL", "https://asciimoo.github.io/searx/") @@ -35,7 +36,7 @@ extlinks['wiki'] = ('https://github.com/asciimoo/searx/wiki/%s', ' ') extlinks['pull'] = ('https://github.com/asciimoo/searx/pull/%s', 'PR ') # links to custom brand -extlinks['origin'] = (GIT_URL + '/blob/master/%s', 'git://') +extlinks['origin'] = (GIT_URL + '/blob/' + GIT_BRANCH + '/%s', 'git://') extlinks['patch'] = (GIT_URL + '/commit/%s', '#') extlinks['search'] = (SEARX_URL + '/%s', '#') extlinks['docs'] = (DOCS_URL + '/%s', 'docs: ') -- cgit v1.2.3 From f25da6070e398f17c24b194c8688595050dc473c Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Tue, 3 Mar 2020 16:26:02 +0100 Subject: docs: generic documentation get templating Signed-off-by: Markus Heiser --- docs/conf.py | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 8f11b1c6c..6a6633341 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,6 +23,8 @@ master_doc = "index" source_suffix = '.rst' numfig = True +exclude_patterns = ['build-templates/*.rst'] + from searx import webapp jinja_contexts = { 'webapp': dict(**webapp.__dict__) -- cgit v1.2.3 From 2d956696e94e5639db6e12648442989919c48c22 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Sat, 21 Mar 2020 18:45:38 +0100 Subject: docs: building (PDF) books / build user book BTW: cleaned up Makefile target help Signed-off-by: Markus Heiser --- docs/conf.py | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 6a6633341..c2b2bbd84 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,7 @@ # -*- coding: utf-8 -*- import sys, os +from sphinx_build_tools import load_sphinx_config from searx.version import VERSION_STRING from pallets_sphinx_themes import ProjectLink @@ -116,3 +117,9 @@ html_show_sourcelink = False latex_documents = [ (master_doc, "searx-{}.tex".format(VERSION_STRING), html_title, author, "manual") ] + +# ------------------------------------------------------------------------------ +# Since loadConfig overwrites settings from the global namespace, it has to be +# the last statement in the conf.py file +# ------------------------------------------------------------------------------ +load_sphinx_config(globals()) -- cgit v1.2.3 From 7b4cf2eb489d8f6c95ccac5af180254b78e7c460 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Sun, 29 Mar 2020 15:09:34 +0200 Subject: tooling box: simplify build enviroments - no more need for a .config.mk - docs: use searx.brands environment - searx.sh, filtron.sh & morty.sh are sourcing utils/brand.env Signed-off-by: Markus Heiser --- docs/conf.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index c2b2bbd84..761465c47 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -5,10 +5,10 @@ from sphinx_build_tools import load_sphinx_config from searx.version import VERSION_STRING from pallets_sphinx_themes import ProjectLink -GIT_URL = os.environ.get("GIT_URL", "https://github.com/asciimoo/searx") +from searx.brand import GIT_URL GIT_BRANCH =os.environ.get("GIT_BRANCH", "master") -SEARX_URL = os.environ.get("SEARX_URL", "https://searx.me") -DOCS_URL = os.environ.get("DOCS_URL", "https://asciimoo.github.io/searx/") +from searx.brand import SEARX_URL +from searx.brand import DOCS_URL # Project -------------------------------------------------------------- -- cgit v1.2.3 From 0742c2504dae04ac054d263de8a2b8ab6161312c Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Sun, 29 Mar 2020 16:28:17 +0200 Subject: build environment: add GIT_BRANCH variable Signed-off-by: Markus Heiser --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 761465c47..9e6d32931 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -6,7 +6,7 @@ from searx.version import VERSION_STRING from pallets_sphinx_themes import ProjectLink from searx.brand import GIT_URL -GIT_BRANCH =os.environ.get("GIT_BRANCH", "master") +GIT_BRANCH = os.environ.get("GIT_BRANCH", "master") from searx.brand import SEARX_URL from searx.brand import DOCS_URL -- cgit v1.2.3 From aa5f947157869f9d53eacd820cc9e5400c95132c Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Thu, 18 Jun 2020 18:51:31 +0200 Subject: [enh] add 'kernel-include' reST-directive Signed-off-by: Markus Heiser --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 9e6d32931..1f79e4c14 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -66,6 +66,7 @@ extensions = [ "sphinx_issues", # https://github.com/sloria/sphinx-issues/blob/master/README.rst "sphinxcontrib.jinja", # https://github.com/tardyp/sphinx-jinja "sphinxcontrib.programoutput", # https://github.com/NextThought/sphinxcontrib-programoutput + 'linuxdoc.kernel_include', # Implementation of the 'kernel-include' reST-directive. 'linuxdoc.rstFlatTable', # Implementation of the 'flat-table' reST-directive. 'linuxdoc.kfigure', # Sphinx extension which implements scalable image handling. "sphinx_tabs.tabs", # https://github.com/djungelorm/sphinx-tabs -- cgit v1.2.3