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.

• Images that switch between color schemes. Released as sphinx-colorschemed-images.

• Diverse color sets are available: blue, indigo, purple, pink, red, orange, yellow, …

• Header and footer links. Header links can be grouped in dropdown elements.

• Display large tables and Mermaid diagrams in a modal window.

• Optional highlighting of the project repository in the header.

• Optional project version selector in the header.

• Back-to-top button.

Take a look at the Theme Options to see all the customizable features.

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:

• Quick start
  • In a blink of an eye
  • Customize the theme
  • Custom CSS
  • Rebuild your site

User’s guide

• User’s guide
  • Installation
  • Customization
  • Localization
  • Theme Options
  • Components

Contributing

Nefertiti for Sphinx is an Open Source project maintained by a small group of developers in their free time. You might want to contribute to further develop it:

• Accessibility
• Development
• Contributing

How to collaborate

There are additional ways to contribute:

• If something is not working, or

• if there is wrong or missing information in the documentation, or

• if you would like to suggest an idea or improvement,

please, create an entry in the issues page of Nefertiti’s repository and explain the details.

If you would like to get help about a topic related with Nefertiti for Sphinx, it is better to submit a question to the discussions page.