Skip to content

Commit

Permalink
Reactive the viewcode extension for docs (Cherry-pick of #1312) (#1315)
Browse files Browse the repository at this point in the history
We got source links working in API docs on docs.quantum.ibm.com! See Qiskit/documentation#620. To do this, we need to active `sphinx.ext.viewcode`.

Note that we still plan to improve this implementation in the future to have more precise links by using `sphinx.ext.linkcode`, tracked by Qiskit/documentation#517. This PR is to unblock the first iteration of this source links mechanism.
  • Loading branch information
Eric-Arellano authored Jan 12, 2024
1 parent 4d06ac3 commit 2910ab0
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@
'sphinx.ext.napoleon',
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
# This is used by qiskit/documentation to generate links to github.com.
"sphinx.ext.viewcode",
'sphinx.ext.mathjax',
'jupyter_sphinx',
'sphinx_autodoc_typehints',
Expand Down

0 comments on commit 2910ab0

Please sign in to comment.