Fix install and use of Jupyter Kernel for docs (#845)

* Try to fix Jupyter kernel name * Display kernels in tox.ini * Install kernel because it is not installed apparently * Add ipykernel to dependencies * Add correct way to set kernel name
Qiskit · Mar 23, 2023 · de75534 · de75534
1 parent e65185c
commit de75534
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -115,6 +115,9 @@
    u'rustworkx Contributors', 'manual'),
 ]
 
+# Jupyter Sphinx options
+jupyter_execute_default_kernel = "python3"
+
 # Texinfo options
 
 texinfo_documents = [

diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt
@@ -9,3 +9,4 @@ qiskit-sphinx-theme>=1.7
 matplotlib>=3.4
 sphinx-reredirects
 sphinxemoji
+ipykernel
diff --git a/tox.ini b/tox.ini
@@ -47,6 +47,8 @@ deps =
 passenv = {[testenv]passenv} RETWORKX_DEV_DOCS RETWORKX_LEGACY_DOCS
 changedir = {toxinidir}/docs
 commands =
+  python -m ipykernel install --user
+  jupyter kernelspec list
   sphinx-build -W -b html source build/html {posargs}
 
 [testenv:black]