Nefertiti for Sphinx

Nefertiti is a theme for Sphinx that features:

• Responsive design, based on Bootstrap 5.3.
• Text input field to filter the index.
• 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.

See it in action in sphinx-themes.org.

Index filtering

By default the index shows the content folded. Opening or closing items is remembered while browsing the documentation. To quickly find items use the input filter. The filter will display items that could be invisible within a folded item. When the user types in the input field, let us say fo, the index gets filtered with all the entries that match those two characters. So the index will display three matches: Fonts, Footer links and Footnotes. Those three entries were all folded within their sections:

The TOC on the right side

The Table of Contents, displayed on the right side, spans itself to the right border of the browser to display long items, improving readability.

Other features

Nefertiti for Sphinx comes with the following color sets. Change between them using the attribute display of the html_theme_options setting.

In order to be compliant with EU's GDPR, Nefertiti for Sphinx comes bundled with a group of fonts licensed for free distribution. Adding more fonts is explained in the User's Guide:

• Assistant
• Exo
• Montserrat
• Mulish
• Nunito
• Open Sans
• Red Hat Display
• Sofia Sans
• Ubuntu
• Varta
• Work Sans
• Fira Code (monospace)
• Red Hat Mono (monospace)
• Ubuntu Mono (monospace)

Combine up to 5 different fonts:

html_theme_options = {
    "sans_serif_font": "Nunito",
    "documentation_font": "Open Sans",
    "monospace_font": "Ubuntu Mono",
    "project_name_font": "Nunito",
    "doc_headers_font": "Georgia",

    "documentation_font_size": "1.2rem",
    "monospace_font_size": "1.1rem",
}

To use it

Install the package from PyPI:

pip install sphinx-nefertiti

Edit the conf.py file of your Sphinx project and change the html_theme setting:

html_theme = "sphinx_nefertiti"

Now rebuild the docs and serve them to get a first glimpse of your site made up with Nefertiti for Sphinx. It has many customizable options worth to explore. You might want to continue reading the customization section of the docs.

To develop it

Clone the Git repository, create a Python virtual environment, and install the NodeJS packages:

git clone [email protected]:danirus/sphinx-nefertiti.git
cd sphinx-nefertiti
python3.12 -m venv venv
source venv/bin/activate
pip install -r requirements-dev.txt
nvm use --lts
npm install

Before contributing, please, install the pre-commit hook scripts:

pre-commit install

There are a comprehensive number of scripts in the package.json. Beyond them there is a Makefile that saves time when building the CSS and JavaScript bundles to deliver them within the Python package of the theme.

Further read the following sections:

• For Style development
• For JavaScript development
• For Sphinx theme development

License

Project distributed under the MIT License.