Commit Graph

7 Commits

Author SHA1 Message Date
Takeshi KOMIYA
c6230dc4db extlinks: Disable hardcoded links detector by default (refs: #10126)
The hardcoded links detector added since 4.4.0 causes troubles in many
projects.  Therefore, this disables it by default, and adds a new
configuration `extlinks_detect_hardcoded_links` to enable it explicitly.
2022-03-27 15:22:11 +09:00
Takeshi KOMIYA
d59e96c8b4 docs: Add versionchanged tag to extlinks (refs: #8898) 2021-04-11 22:25:48 +09:00
Merry Bass
75605d437f fixup! sphinx.ext.extlinks: Clarify escaping of `%` 2021-04-11 22:14:24 +09:00
Merry Bass
ef1747f03a sphinx.ext.extlinks: Clarify escaping of `%`
We use Pythons %-formatting, so literal ``%`` must be escaped as ``%%``.
Clarify this behaviour for the caption and base URL strings.
2021-04-11 22:14:17 +09:00
Merry Bass
fb39974486 sphinx.ext.extlinks: Allow `%s` in link caption string
Tweak syntax of extlinks to also allow ``%s`` in the link caption part.
Like for the base URL ``%s`` will be substituted with the content of the
role.  This allows configurations like

    extlinks = {'quarter': ('https://example.org/quaters/%s',
                          '%s. quarter')}

with ``:quarter:`2``` getting replaced by a link titled `2. quarter`.

The requirement for the caption string is to be either None or contain
exactly one ``%s``.  If neither is the case, then we emit a warning and
fall back to the old behaviour which is concatenating the caption string
with the role content.
2021-04-11 22:14:01 +09:00
Takeshi KOMIYA
ceef713e79 docs: Remove a term "new" from config values 2019-02-27 01:18:57 +09:00
Stephen Finucane
d9ccc95717 doc: Add "extensions" to usage guide
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-06-20 09:30:47 +01:00