Nefertiti for Sphinx¶
Nefertiti for Sphinx is a customizable theme for Sphinx.
The name is taken from the figure of Nefertiti, the queen of the 18th Dynasty of Ancient Egypt (Wikipedia). Women in ancient Egypt had more rights than many women living in the present day (World History Encyclopedia).
This documentation explains how to make use of the Nefertiti theme with Sphinx projects.
Features¶
Responsive design, based on Bootstrap 5.3.
Text input field to filter the table of contents.
Font configuration compliant with EU’s GDPR.
Different fonts can be used for different elements.
Light and dark color schemes, for normal text and code highlighted with Pygments styles.
Diverse color sets are available: blue, indigo, purple, pink, red, orange, yellow, …
Optional highlighting of the project repository in the header.
Optional project version selector in the header.
Customizable footer links.
Project background¶
Nefertiti for Sphinx is based on other themes, like the Sphinx Wagtail theme, the Read the Docs theme and the elegant Alabaster. Some visual elements and options are based on Material for MkDocs.
To the authors and contributors of such projects, thank you for the hard work and inspiration.
Getting started¶
Start with these documents to get you up and running: