Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Sphinx: generating an external link

I'd like to link to some URL in my Sphinx docs:

<a href="http://some.url">blah</a> 

I have found something similar in the docs: http://sphinx-doc.org/ext/extlinks.html - but it is rather about replacing the custom syntax with the link, by convention. Instead, I just want to generate a link to external web resource.

like image 518
Anton Arhipov Avatar asked Jun 19 '13 10:06

Anton Arhipov


1 Answers

Found the answer in the reStructuredText documentation. It can be done either with a named reference:

Test hyperlink: SO_.      .. _SO: https://stackoverflow.com/ 

Or with an embedded URI:

Test hyperlink: `Stack Overflow <https://stackoverflow.com/>`_. 
like image 83
Anton Arhipov Avatar answered Sep 20 '22 15:09

Anton Arhipov