IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-09-03 20:52:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

Make extlinks more flexible: use string substitution to build the full URL.

Browse Source
This commit is contained in:
Georg Brandl
2010-01-02 20:51:22 +01:00
parent 32437e45bd
commit 6b13a28c11
7 changed files with 34 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/ext/extlinks.rst
+3 -1
View File
@@ -27,11 +27,13 @@ The extension adds one new config value:
short alias names to a base URL and a *prefix*. For example, to create an
alias for the above mentioned issues, you would add ::
extlinks = {'issue': ('http://bitbucket.org/birkenfeld/sphinx/issue/',
extlinks = {'issue': ('http://bitbucket.org/birkenfeld/sphinx/issue/%s',
'issue ')}
Now, you can use the alias name as a new role, e.g. ``:issue:`123```. This
then inserts a link to http://bitbucket.org/birkenfeld/sphinx/issue/123.
As you can see, the target given in the role is substituted in the base URL
in the place of ``%s``.
The link *caption* depends on the second item in the tuple, the *prefix*: