sphinx.ext.extlinks

Extension to save typing and prevent hard-coding of base URLs in the reST files.

This adds a new config value called extlinks that is created like this:

extlinks = {'exmpl': ('https://example.invalid/%s.html', caption), ...}

Now you can use e.g. :exmpl:`foo` in your documents. This will create a link to https://example.invalid/foo.html. The link caption depends on the caption value given:

• If it is None, the caption will be the full URL.
• If it is a string, it must contain %s exactly once. In this case the caption will be caption with the role content substituted for %s.

You can also give an explicit caption, e.g. :exmpl:`Foo <foo>`.

Both, the url string and the caption string must escape % as %%.