Skip to main content

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

  1. 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.

  2. 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.

  3. 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

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.34.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.34.0
File Size Uploaded Provenance Actions
pennylane_sphinx_theme-0.34.0.tar.gz 21.7 kB With provenance Details for pennylane_sphinx_theme-0.34.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pennylane-sphinx-theme 0.34.0
File Interpreter ABI Platform Actions
pennylane_sphinx_theme-0.34.0-py3-none-any.whl Python 3 none any Details for pennylane_sphinx_theme-0.34.0-py3-none-any.whl

Total release size: 43.8 kB

Release files / pennylane_sphinx_theme-0.34.0.tar.gz

Download URL pennylane_sphinx_theme-0.34.0.tar.gz
Size 21.7 kB
Tags Source
SHA-256 checksum
How to use checksums
d1baee5d95e5021f9196c62c069d98e004c41eab8b6e9dfb2074c85e18503396
BLAKE2b-256 checksum
How to use checksums
f792d7aa06703ed5363b15cee11a36ecc56305c64dfda336bf9fecc49e85399d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.

Transparency log

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

Download URL pennylane_sphinx_theme-0.34.0-py3-none-any.whl
Size 22.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6a96f4cc8ea7a1008aa1362d0b0d50898f0fa9cf17382d6d1779996884116382
BLAKE2b-256 checksum
How to use checksums
e34bbf9332b907781ad03fe0096c8d16992cbeae6cb40af7033a6ced51c7febe
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.

Transparency log

Security for pennylane-sphinx-theme 0.34.0

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for pennylane_sphinx_theme-0.34.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.34.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page