From 4fc317ba59a7e616a55c2d12838609cca405f6dc Mon Sep 17 00:00:00 2001 From: Shraddha Aangiras <63237790+shraddha-aangiras@users.noreply.github.com> Date: Fri, 5 Jul 2024 18:39:34 +0530 Subject: [PATCH] Added Intersphinx and mapping --- docs/conf.py | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 60081d75c..1c2d58d65 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -35,6 +35,7 @@ 'sphinx.ext.napoleon', 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', + 'sphinx.ext.intersphinx', # This is used by qiskit/documentation to generate links to github.com. "sphinx.ext.linkcode", 'jupyter_sphinx', @@ -65,6 +66,19 @@ link_str = f" https://github.com/Qiskit/qiskit-ibm-runtime/blob/stable/{vers[0]}.{vers[1]}/docs/" nbsphinx_prolog += link_str + "{{ docname }}" +# ---------------------------------------------------------------------------------- +# Intersphinx +# ---------------------------------------------------------------------------------- + +intersphinx_mapping = { + "rustworkx": ("https://www.rustworkx.org/", None), + "qiskit": ("https://docs.quantum.ibm.com/api/qiskit/", None), + "qiskit-aer": ("https://qiskit.github.io/qiskit-aer/", None), + "numpy": ("https://numpy.org/doc/stable/", None), + "matplotlib": ("https://matplotlib.org/stable/", None), + "python": ("https://docs.python.org/3/", None), +} + # ----------------------------------------------------------------------------- # Autosummary # -----------------------------------------------------------------------------