Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix install and use of Jupyter Kernel for docs #845

Merged
merged 6 commits into from
Mar 23, 2023
Merged

Fix install and use of Jupyter Kernel for docs #845

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ddc7527
Try to fix Jupyter kernel name
IvanIsCoding Mar 22, 2023
846a874
Display kernels in tox.ini
IvanIsCoding Mar 22, 2023
369f69a
Merge remote-tracking branch 'upstream/main' into fix-jupyter-errors
IvanIsCoding Mar 22, 2023
7a9d02d
Install kernel because it is not installed apparently
IvanIsCoding Mar 22, 2023
cd4b0ba
Add ipykernel to dependencies
IvanIsCoding Mar 22, 2023
f271625
Add correct way to set kernel name
IvanIsCoding Mar 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,9 @@
u'rustworkx Contributors', 'manual'),
]

# Jupyter Sphinx options
jupyter_execute_default_kernel = "python3"

# Texinfo options

texinfo_documents = [
Expand Down
1 change: 1 addition & 0 deletions docs/source/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ qiskit-sphinx-theme>=1.7
matplotlib>=3.4
sphinx-reredirects
sphinxemoji
ipykernel
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm quite surprised this isn't getting pulled in anymore. I would expect jupyter-sphinx to end up pulling this in.

2 changes: 2 additions & 0 deletions tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down