Skip to content

Commit 42c9d97

Browse files
Sphinx upgrade (#1581)
**Title:** Upgrade Sphinx and Jinja2 versions. **Summary:** - Replaces PR #1579. The RC branch builds will be deferred to a later date. - Upgrade Sphinx to version 8.1 and Jinja2 to 3.1.6 - All demos in the `master` branch successfully build. - Some reference formatting inconsistencies spotted. **Notes** Testing deployment of the built demos show inconsistencies in the way references are formatted in the text and at the bottom of the demo. Current Production website version: <img width="821" height="117" alt="Screenshot 2025-10-24 at 3 35 35 PM" src="https://github.com/user-attachments/assets/c44e8908-c71d-48ce-aa92-9ff947c14200" /> <img width="836" height="400" alt="Screenshot 2025-10-24 at 3 36 08 PM" src="https://github.com/user-attachments/assets/d739d2af-003f-4845-b6fd-0cebb4e3021a" /> With the Sphinx upgrade: <img width="832" height="117" alt="Screenshot 2025-10-24 at 3 35 23 PM" src="https://github.com/user-attachments/assets/b4b63e77-77e2-4d45-b896-5833e10761a2" /> <img width="836" height="477" alt="Screenshot 2025-10-24 at 3 35 59 PM" src="https://github.com/user-attachments/assets/e3740780-3cfc-4e9d-b238-78554d10cfa7" /> **Note**: The above rendering issues are fixed in [this PR](XanaduAI/pennylane.ai-react#2368). We'll merge this first so we can build and upload all the demos, then merge the pennylane.ai PR to fix the rendering on the website. --------- Co-authored-by: runora95 <runor.agbaire@xanadu.ai>
1 parent 634e5ba commit 42c9d97

File tree

4 files changed

+49
-54
lines changed

4 files changed

+49
-54
lines changed

conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444

4545
# If your documentation needs a minimal Sphinx version, state it here.
4646
#
47-
needs_sphinx = "1.8.5"
47+
needs_sphinx = "8.1"
4848

4949
# Add any Sphinx extension module names here, as strings. They can be
5050
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Build dependencies
2-
sphinx>=5.0.2
2+
sphinx==8.1
33
sphinx_gallery==0.17.1
4-
Jinja2==3.0.3
4+
Jinja2==3.1.6
55
markupsafe==2.1.1
66
pyyaml~=6.0.1
77
pypandoc==1.5
8-
pennylane-sphinx-theme @ git+https://github.com/PennyLaneAI/pennylane-sphinx-theme.git@sphinx-update
8+
pennylane-sphinx-theme
99
uv~=0.7.18
1010
numpy~=1.24
1111
pennylane

poetry.lock

Lines changed: 42 additions & 47 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,12 +62,12 @@ build-backend = "poetry.core.masonry.api"
6262
# Base dependencies needed to build the website without any code execution (*-norun)
6363
# When updating these, ensure that the accompanying /dependencies/requirements-build.txt is also updated.
6464
[tool.poetry.group.base.dependencies]
65-
sphinx = ">=5.0.2"
65+
sphinx = "8.1"
6666
sphinx_gallery = "0.17.1"
67-
Jinja2 = "3.0.3"
67+
Jinja2 = "3.1.6"
6868
markupsafe = "2.1.1"
6969
pyyaml = "^6.0.1"
70-
pennylane-sphinx-theme = { git = "https://github.com/PennyLaneAI/pennylane-sphinx-theme.git", branch = "sphinx-update" }
70+
pennylane-sphinx-theme = "0.25.0"
7171
pypandoc = "1.5"
7272
pennylane = "0.43.0"
7373
uv = "^0.7.18"

0 commit comments

Comments
 (0)