How to add external links

Note

This page was written in the style of a How-to Guide according to The Diátaxis Framework.

This guide shows how to include links to pages outside your documentation.

There are two types of files

.rst

In order to link to an external page you have to write `text of your link <your_url>`_. For example, you can link to IBM Quantum documentation by writing:

`IBM Quantum documentation <https://docs.quantum.ibm.com>`_

Note

You can also use sphinx.ext.intersphinx to link to pages from other project’s documentation using the cross-reference syntax. For more information about cross-referencing and using sphinx.ext.intersphinx, check How to cross-reference to other pages from documentation.

.ipynb

If your file is a Jupyter notebook, what you have to write to link to a page is [text of your link](your_url). If you want to link to IBM Quantum Documentation you can write:

[Qiskit's page](https://docs.quantum.ibm.com)

Warning

Avoid including backquotes ` as part of the text of your link. Qiskit’s documentation uses nbsphinx to convert the .ipynb files to .rst and then to HTML. So, even though the links will work and look fine in a Jupyter notebook, they will not format properly in the actual documentation because .rst doesn’t admit the backquotes.