summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMerry Bass <79108256+merrybass@users.noreply.github.com>2021-04-09 10:30:57 +0000
committerMerry Bass <79108256+merrybass@users.noreply.github.com>2021-04-09 10:35:26 +0000
commit120daeea33e3b49ed825115a66ab4375de56e94c (patch)
treefe0314a4c4de5080e0bb7822938ff466323e70f1
parentc39f147d441bb34b2081c4179145b4acdc86f0a3 (diff)
downloadsphinx-git-120daeea33e3b49ed825115a66ab4375de56e94c.tar.gz
fixup! sphinx.ext.extlinks: Clarify escaping of ``%``
-rw-r--r--doc/usage/extensions/extlinks.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/usage/extensions/extlinks.rst b/doc/usage/extensions/extlinks.rst
index 2ef4d6b55..221b79d99 100644
--- a/doc/usage/extensions/extlinks.rst
+++ b/doc/usage/extensions/extlinks.rst
@@ -44,8 +44,8 @@ The extension adds a config value:
To produce a literal ``%`` in either *base URL* or *caption*, use ``%%``::
- extlinks = {'wikipedia': ('https://en.wikipedia.org/w/index.php?search=%s&title=Special%%3ASearch&fulltext=Search&ns0=1'
- 'Search %s on Wikipedia')}
+ extlinks = {'KnR': ('https://example.org/K%%26R/page/%s',
+ '[K&R; page %s]')}
You can also use the usual "explicit title" syntax supported by other roles
that generate links, i.e. ``:issue:`this issue <123>```. In this case, the