emprice / furiosa

A Nord twist on the Furo theme

furiosa: A Nord twist on the Sphinx furo theme

A full demonstration is available here.

• Building and installing
• Credits and dependencies

🔩 Building and installing

To build and install this package with pip, the same procedure can be followed as for most pure Python packages that use setuptools. In the install step, some optional flags are given below in brackets that can be useful for a non-root build (--user) or for active development (--ignore-installed --force-reinstall), but these are not strictly necessary to install the package itself.

python3 -m build
pip3 install [--user] [--ignore-installed --force-reinstall] dist/furiosa-<version>.whl

To build the demo, the command below should be sufficient.

sphinx-build -M html demo <output dir>

💎 Credits and dependencies

• Furo is the theme upon which this customization is based. Credit for its development goes entirely to @pradyunsg, and parts of my code that override bits of Furo are based on their code as well.
• The Nord colorscheme is a beautiful set of color palettes with a frosty blue feel. I love these colors and use them in many places, not just documentation.
• This extension additionally depends on Sphinx, Pygments, and webcolors. Everything else is included in the Python standard library.