Getting Started¶
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
Setting up the theme¶
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"
}
started
Download Python script
Download Notebook
View on GitHub