Skip to main content

A Sphinx-doc theme based on Vuepress

Project description

A modern responsive theme for python’s Sphinx documentation generator based on sphinx_press_theme and ablog.

This theme is based on VuePress. It uses Vue.js and LessCSS managed by webpack through vue-cli.


On Sphinx project’s set the theme name to nervproject.

html_theme = "nervproject"

See details on Sphinx theming docs.


To rebuild web assets:

npm run build

Install theme locally with pip install -e ..

docs folder contains theme’s own documentantion.

cd docs
make clean; make html


This theme needs CSS vars enabled in the browser, so it doesn’t work on IE. Four color variations are available :

  • light low contrast (default) ;

  • light high contrast ;

  • dark low contrast ;

  • dark high contrast.

The good one is used based on prefers-contrast and prefers-color-scheme media queries. This is automatically done by a compatible browser. If not, the default theme is used. Some browsers need manual configuration like Chromium on Linux (a flag to enable for all websites).


See the Nerv Project’s web site

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_nervproject_theme-3.0.2.tar.gz (1.5 MB view hashes)

Uploaded Source

Built Distribution

sphinx_nervproject_theme-3.0.2-py3-none-any.whl (1.5 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page