.. sphinx-nefertiti documentation master file, created by
   sphinx-quickstart on Fri Dec 16 11:26:28 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

:hidetoc: 1

====================
Nefertiti for Sphinx
====================

Nefertiti for Sphinx is a customizable theme for `Sphinx <https://www.sphinx-doc.org/en/master/>`_.

The name is taken from the figure of Nefertiti, the queen of the 18th Dynasty of Ancient Egypt (`Wikipedia <https://en.wikipedia.org/wiki/Nefertiti>`_). Women in ancient Egypt had more rights than many women living in the present day (`World History Encyclopedia <https://www.worldhistory.org/article/623/women-in-ancient-egypt/>`_).

This documentation explains how to make use of the Nefertiti theme with Sphinx projects.

Features
========

* Responsive design, based on `Bootstrap 5.3 <https://getbootstrap.com/docs/5.3>`_.
* Text input field to filter the table of contents.
* Font configuration compliant with `EU's GDPR <https://gdpr.eu/>`_.
* 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 <https://pypi.org/project/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 :doc:`users-guide/theme-options` to see all the customizable features.

Project background
==================

Nefertiti for Sphinx is based on other themes, like the `Sphinx Wagtail theme <https://sphinx-wagtail-theme.readthedocs.io/>`_, the `Read the Docs theme <https://sphinx-rtd-theme.readthedocs.io/>`_ and the elegant `Alabaster <https://alabaster.readthedocs.io/en/latest/>`_. Some visual elements and options are based on `Material for MkDocs <https://squidfunk.github.io/mkdocs-material/>`_.

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:

.. toctree::
   :maxdepth: 2

   quick-start

User's guide
============

.. toctree::
   :maxdepth: 2

   users-guide/index

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:

.. toctree::
   :maxdepth: 1

   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 <https://github.com/danirus/sphinx-nefertiti/issues>`_ 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 <https://github.com/danirus/sphinx-nefertiti/discussions>`_.