From eb5bea16ff31436a16d31f53f980611f052bd1e8 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Tue, 5 Jul 2022 17:05:06 +0200 Subject: [fix] sphinx 5.x: add `nav.contents` everywhere that `div.topic` is used Previously, docutils produced `div.topic` for the contents directive, the latest version produces `nav.contents`. This means that those tables of contents change appearance when switching to docutils 0.18 [1][2]. [1] https://github.com/sphinx-doc/sphinx/pull/10535/commits/5806f0a [2] https://github.com/sphinx-doc/sphinx/issues/10534 Signed-off-by: Markus Heiser --- docs/_themes/searxng/static/searxng.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/_themes/searxng/static/searxng.css b/docs/_themes/searxng/static/searxng.css index 1ab8489ec..a214bc9d1 100644 --- a/docs/_themes/searxng/static/searxng.css +++ b/docs/_themes/searxng/static/searxng.css @@ -40,7 +40,7 @@ p.sidebar-title, .sidebar p { /* admonitions */ -div.admonition, div.topic, div.toctree-wrapper { +div.admonition, div.topic, nav.contents, div.toctree-wrapper { background-color: #fafafa; margin: 8px 0px; padding: 1em; -- cgit v1.2.3 From d3226b3df582cfc8291d045df26886dc7c481be3 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Tue, 5 Jul 2022 17:10:19 +0200 Subject: [fix] Sphinx 5.x: will warn about missleading extlink definitions This patch fixes the WARNING messages that pops up since Sphinx 5.x: WARNING: extlinks: Sphinx-6.0 will require a caption string to contain exactly one '%s' and all other '%' need to be escaped as '%%'. [1] https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html Signed-off-by: Markus Heiser --- docs/conf.py | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index e2bbd1285..44d1c2ad9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -88,26 +88,26 @@ def setup(app): extlinks = {} # upstream links -extlinks['wiki'] = ('https://github.com/searxng/searxng/wiki/%s', ' ') -extlinks['pull'] = ('https://github.com/searxng/searxng/pull/%s', 'PR ') -extlinks['pull-searx'] = ('https://github.com/searx/searx/pull/%s', 'PR ') +extlinks['wiki'] = ('https://github.com/searxng/searxng/wiki/%s', ' %s') +extlinks['pull'] = ('https://github.com/searxng/searxng/pull/%s', 'PR %s') +extlinks['pull-searx'] = ('https://github.com/searx/searx/pull/%s', 'PR %s') # links to custom brand -extlinks['origin'] = (GIT_URL + '/blob/' + GIT_BRANCH + '/%s', 'git://') -extlinks['patch'] = (GIT_URL + '/commit/%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['origin'] = (GIT_URL + '/blob/' + GIT_BRANCH + '/%s', 'git://%s') +extlinks['patch'] = (GIT_URL + '/commit/%s', '#%s') +extlinks['docs'] = (DOCS_URL + '/%s', 'docs: %s') +extlinks['pypi'] = ('https://pypi.org/project/%s', 'PyPi: %s') +extlinks['man'] = ('https://manpages.debian.org/jump?q=%s', '%s') #extlinks['role'] = ( # 'https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-%s', '') extlinks['duref'] = ( - 'https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#%s', '') + 'https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#%s', '%s') extlinks['durole'] = ( - 'https://docutils.sourceforge.io/docs/ref/rst/roles.html#%s', '') + 'https://docutils.sourceforge.io/docs/ref/rst/roles.html#%s', '%s') extlinks['dudir'] = ( - 'https://docutils.sourceforge.io/docs/ref/rst/directives.html#%s', '') + 'https://docutils.sourceforge.io/docs/ref/rst/directives.html#%s', '%s') extlinks['ctan'] = ( - 'https://ctan.org/pkg/%s', 'CTAN: ') + 'https://ctan.org/pkg/%s', 'CTAN: %s') extensions = [ 'sphinx.ext.imgmath', -- cgit v1.2.3