The customizable Sphinx theme with a feminine character.
Project description
Nefertiti for Sphinx
Nefertiti for Sphinx is yet another Sphinx theme.
Here is a screenshot, but visiting the documentation site will give 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 git@github.com: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:
License
Project distributed under the MIT License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinx_nefertiti-0.1.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f8d24b8df6d8e149fedb69cd2505fe692bb7cd558af6493075608f866f14793 |
|
MD5 | d1e2aec9e259da47ec4ef5d21bf985c9 |
|
BLAKE2b-256 | 48bc42cf43b85d8fee34ef718f0a504074edfbb8dda0dd8b4de96f9de3e6cacc |