PennyLane Sphinx Theme¶
- Release
0.34.0-dev
Features¶
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.
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.