https://github.com/pennylaneai/pennylane-sphinx-theme
Sphinx theme for PennyLaneAI repositories
https://github.com/pennylaneai/pennylane-sphinx-theme
Last synced: 4 months ago
JSON representation
Sphinx theme for PennyLaneAI repositories
- Host: GitHub
- URL: https://github.com/pennylaneai/pennylane-sphinx-theme
- Owner: PennyLaneAI
- License: apache-2.0
- Created: 2022-09-23T00:55:48.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2025-04-23T20:32:00.000Z (about 1 year ago)
- Last Synced: 2025-04-23T21:32:29.191Z (about 1 year ago)
- Language: Python
- Homepage: https://docs.pennylane.ai/projects/sphinx-theme
- Size: 649 KB
- Stars: 2
- Watchers: 12
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
PennyLane Sphinx Theme
######################
.. header-start-inclusion-marker-do-not-remove
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``.
For more details, please see the
`Xanadu Sphinx Theme documentation `__.
.. header-end-inclusion-marker-do-not-remove
Installation
============
.. installation-start-inclusion-marker-do-not-remove
The PennyLane Sphinx Theme requires Python 3.7 or later. The latest version of the
theme can be installed directly using ``pip``:
.. code-block:: bash
pip install pennylane-sphinx-theme
.. installation-end-inclusion-marker-do-not-remove
Getting Started
===============
.. getting-started-start-inclusion-marker-do-not-remove
Once installed, simply add or modify the following variables of your Sphinx
``conf.py`` configuration file to start using the PennyLane Sphinx Theme:
.. code-block:: python
from pennylane_sphinx_theme import templates_dir
templates_path = [templates_dir()]
html_theme = "pennylane"
html_theme_options = {
"navbar_name": "Example Project"
}
.. getting-started-end-inclusion-marker-do-not-remove
Configuration
=============
.. configuration-start-inclusion-marker-do-not-remove
The PennyLane Sphinx Theme supports the same configration options as
the Xanadu Sphinx Theme. For more details, please see the
`Xanadu Sphinx Theme documentation `__.
.. configuration-end-inclusion-marker-do-not-remove
Directives
==========
.. directives-start-inclusion-marker-do-not-remove
The PennyLane Sphinx Theme provides various directives.
For more details, please see the
`Xanadu Sphinx Theme documentation `__.
.. directives-end-inclusion-marker-do-not-remove
Release
============
.. release-start-inclusion-marker-do-not-remove
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.
.. release-end-inclusion-marker-do-not-remove
Support
=======
.. support-start-inclusion-marker-do-not-remove
- **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.
.. support-end-inclusion-marker-do-not-remove
License
=======
.. license-start-inclusion-marker-do-not-remove
The PennyLane Sphinx Theme is **free** and **open source**, released under the
`Apache License, Version 2.0 `_.
.. license-end-inclusion-marker-do-not-remove