Sphinx theme for PennyLane open-source Python packages
Project description
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.
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",
"navbar_active_link": 3
}
Configuration
The PennyLane Sphinx Theme supports the same configration options as the Xanadu Sphinx Theme. It also provides the following additional configuration options:
- navbar_active_link
The link on the left-hand-side of the navbar that should be ‘active’. Active links denote to the user ‘this is the page represented by the navbar link’, and are represented by an accented underline.
The value of this configuration option should be an integer, with 0 representing the first left-hand navbar link.
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.
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pennylane-sphinx-theme-0.3.9.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 13d8accd0fc7deeb25916cfb3febb626ee7010e97129c8f4f8ae68c23b7b4b4e |
|
MD5 | 383f14a4987b6411f0239b1dff9d3210 |
|
BLAKE2b-256 | a3196207476e769327cc1731656f986ca69d215c42f998be24c374203a029e69 |
Hashes for pennylane_sphinx_theme-0.3.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d75370ee9fd72c723d402ee32535c8966d1ddbc5df6699a087c91f6ff2bbb52a |
|
MD5 | 017c259ee350deacacb769603cdae32b |
|
BLAKE2b-256 | 007517831cbc7b3471232190b297869e23f095604dc64e20663eb5b48fc47f26 |