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

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