Skip to content

Commit

Permalink
Added Intersphinx to docs (#1790)
Browse files Browse the repository at this point in the history
* Added Intersphinx and mapping

* Update docs/conf.py

Co-authored-by: Eric Arellano <[email protected]>

---------

Co-authored-by: Eric Arellano <[email protected]>
  • Loading branch information
shraddha-aangiras and Eric-Arellano authored Jul 5, 2024
1 parent 04d05ce commit 5436f0f
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down Expand Up @@ -65,6 +66,18 @@
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),
}

# -----------------------------------------------------------------------------
# Autosummary
# -----------------------------------------------------------------------------
Expand Down

0 comments on commit 5436f0f

Please sign in to comment.