Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Include long url in sphinx documentation

I am very new in Sphinx. So sorry if it is very basic question.

I have a very long url I would like to include in my documentation. If I just include the link in my doc, it looks ugly because it is too long

I tried, to include it in a box doing

Click on the following link ::

   http://my_very_looooooooooooooooooooooog_url

Then, it looks much better since it is on one line only but it is not clickable anymore.

What can I do to have it clickable and on one single line ?

Thank you for your help

like image 694
lizzie Avatar asked Nov 12 '12 12:11

lizzie


People also ask

Does Sphinx support markdown?

To support Markdown-based documentation, Sphinx can use MyST-Parser. MyST-Parser is a Docutils bridge to markdown-it-py, a Python package for parsing the CommonMark Markdown flavor.

What is Sphinx AutoAPI?

Sphinx AutoAPI provides "autodoc" style documentation for multiple programming languages without needing to load, run, or import the project being documented. In contrast to the traditional Sphinx autodoc, which is Python-only and uses code imports, AutoAPI finds and generates documentation by parsing source code.


1 Answers

You can use an any one of the hyperlink constructs available in reStructuredText. One example is to use an embedded URI, as defined in the reStructuredText specification (see, for example, the quick reference), writing:

External hyperlinks, like `Python <http://www.python.org/>`_.

renders like the following:

External hyperlinks, like Python.

like image 142
Chris Avatar answered Sep 23 '22 11:09

Chris