PennyLane Sphinx Theme

The PennyLane Sphinx Theme is a Sphinx theme used for open-source PennyLane software projects hosted on https://pennylane.ai. It extends the Xanadu Sphinx Theme with PennyLane-specific default settings and configurations.

To update the PennyLane navigation bar (navbar) and footer, please see the files pennylane_sphinx_theme/footer.py and pennylane_sphinx_theme/navbar.py.

To update the copy shown in the dismissible toast “coach mark” (e.g. for a survey or campaign promotion), please see pennylane_sphinx_theme/coach_marks.py. This copy is kept in sync by hand with the portal’s coach mark content (coach-marks.ts) — when updating one, update the other to match.

For more details, please see the Xanadu Sphinx Theme documentation.

Installation

The PennyLane Sphinx Theme requires Python 3.7 or later. The latest version of the theme can be installed directly using pip:

pip install pennylane-sphinx-theme

Getting Started

Once installed, simply add or modify the following variables of your Sphinx conf.py configuration file to start using the PennyLane Sphinx Theme:

from pennylane_sphinx_theme import templates_dir
templates_path = [templates_dir()]

html_theme = "pennylane"

html_theme_options = {
    "navbar_name": "Example Project"
}

Configuration

The PennyLane Sphinx Theme supports the same configration options as the Xanadu Sphinx Theme. For more details, please see the Xanadu Sphinx Theme documentation.

Directives

The PennyLane Sphinx Theme provides various directives.

For more details, please see the Xanadu Sphinx Theme documentation.

Release

Make a PR with the desired changes to the PST (pennylane-sphinx-theme).
- Don’t forget to update the CHANGELOG!
- Merge in your PR once it is approved.
Prepare the PST for release.
- Once PR is merged it will trigger the Pre-Release Version Bump workflow.
- The workflow will open a PR Pre-release version bump to X.Y.Z. Adjust the release version number as necessary.
- Merge in the Pre-release version bump to X.Y.Z PR.
Release a new version of the PST.
- Once Pre-release version bump to X.Y.Z PR is merged in it will automatically create new release of PST.
- It will also run the Post-Release Version Bump workflow.
- The workflow will open a Post-release version bump to X.Y.Z PR that can be merged in master to increment the version for next release.

Support

Source Code: https://github.com/XanaduAI/pennylane-sphinx-theme
Issue Tracker: https://github.com/XanaduAI/pennylane-sphinx-theme/issues

If you are having issues, please let us know by posting the issue on our Github issue tracker.

License

The PennyLane Sphinx Theme is free and open source, released under the Apache License, Version 2.0.

Metadata

Release files for pennylane-sphinx-theme 0.33.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pennylane-sphinx-theme 0.33.0
File	Size	Uploaded
pennylane_sphinx_theme-0.33.0.tar.gz	21.7 kB	Oct 1, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for pennylane-sphinx-theme 0.33.0
File	Interpreter	ABI	Platform	Reset
pennylane_sphinx_theme-0.33.0-py3-none-any.whl 22.1 kB Oct 1, 2026	Python 3	none	any	Details

Total release size: 43.8 kB

Release files / pennylane_sphinx_theme-0.33.0.tar.gz

Download URL	pennylane_sphinx_theme-0.33.0.tar.gz
Size	21.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`f70c99d06d68ccd08b9988fe707da42da0d4773a73e2a8bc4808656371fa38c4`
BLAKE2b-256 checksum How to use checksums	`b74b8c8fe8285c274012804d9b1d2b22cae79a3b5f600c3ad66ff07a382fe392`
Upload date	Oct 1, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/PennyLaneAI/pennylane-sphinx-theme
Publishing commit: github.com/PennyLaneAI/pennylane-sphinx-theme/tree/141d9ca1b0a67ed7db990e20718cb4bba5389c4f

Workflow

Publishing configuration: github.com/PennyLaneAI/pennylane-sphinx-theme/blob/141d9ca1b0a67ed7db990e20718cb4bba5389c4f/.github/workflows/upload.yml
Publishing logs: github.com/PennyLaneAI/pennylane-sphinx-theme/actions/runs/36872337237/attempts/1

Artifact

Subject: pennylane_sphinx_theme-0.33.0.tar.gz
SHA-256 checksum: f70c99d06d68ccd08b9988fe707da42da0d4773a73e2a8bc4808656371fa38c4 Verifying attestations

Release files / pennylane_sphinx_theme-0.33.0-py3-none-any.whl

Download URL	pennylane_sphinx_theme-0.33.0-py3-none-any.whl
Size	22.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`84bc7ea1faeaa962ad97d5e9ea7a7c74eed804c78b17b3161e1072b6355624b9`
BLAKE2b-256 checksum How to use checksums	`28908a566a370b857af1b1952eaafa5841b9c2a33ee245f71d2d21905035e7a1`
Upload date	Oct 1, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/PennyLaneAI/pennylane-sphinx-theme
Publishing commit: github.com/PennyLaneAI/pennylane-sphinx-theme/tree/141d9ca1b0a67ed7db990e20718cb4bba5389c4f

Workflow

Publishing configuration: github.com/PennyLaneAI/pennylane-sphinx-theme/blob/141d9ca1b0a67ed7db990e20718cb4bba5389c4f/.github/workflows/upload.yml
Publishing logs: github.com/PennyLaneAI/pennylane-sphinx-theme/actions/runs/36872337237/attempts/1

Artifact

Subject: pennylane_sphinx_theme-0.33.0-py3-none-any.whl
SHA-256 checksum: 84bc7ea1faeaa962ad97d5e9ea7a7c74eed804c78b17b3161e1072b6355624b9 Verifying attestations