Browse Source

[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 <markus.heiser@darmarit.de>
Markus Heiser 2 years ago
parent
commit
d3226b3df5
1 changed files with 12 additions and 12 deletions
  1. 12 12
      docs/conf.py

+ 12 - 12
docs/conf.py

@@ -88,26 +88,26 @@ def setup(app):
 extlinks = {}
 extlinks = {}
 
 
 # upstream links
 # 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
 # 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'] = (
 #extlinks['role'] = (
 #    'https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-%s', '')
 #    'https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-%s', '')
 extlinks['duref'] = (
 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'] = (
 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'] =  (
 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'] =  (
 extlinks['ctan'] =  (
-    'https://ctan.org/pkg/%s', 'CTAN: ')
+    'https://ctan.org/pkg/%s', 'CTAN: %s')
 
 
 extensions = [
 extensions = [
     'sphinx.ext.imgmath',
     'sphinx.ext.imgmath',