sphinx-nefertiti 0.1.2

The Nefertiti for Sphinx theme

Nefertiti for Sphinx

Nefertiti for Sphinx is yet another Sphinx theme.

An image is worth a thousand words, but visiting the documentation site gives a more comprehensive idea.

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 [e-mail]:danirus/sphinx-nefertiti.git
cd sphinx-nefertiti
python3.11 -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.