Sphinx NervProject Theme
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.
Usage
On Sphinx project’s conf.py: set the theme name to nervproject.
html_theme = "nervproject"See details on Sphinx theming docs.
Development
To rebuild web assets:
npm run buildInstall theme locally with pip install -e ..
docs folder contains theme’s own documentantion.
cd docs
make clean; make htmlCompatibility
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).
Example
See the Nerv Project’s web site
1 maintainer
Metadata
1 maintainer
Release files for sphinx-nervproject-theme 3.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_nervproject_theme-3.0.3.tar.gz | 1.5 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_nervproject_theme-3.0.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 3.1 MB
Release files / sphinx_nervproject_theme-3.0.3.tar.gz
| Download URL | sphinx_nervproject_theme-3.0.3.tar.gz |
|---|---|
| Size | 1.5 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
645eeb189d8f4b760b836a92ddcfbec23605390847924d935db01422471e7860
|
|
BLAKE2b-256 checksum How to use checksums |
847251c087678562fc40e8b9cd27dc50d39043bdfe7e08afefd3be4e1fef3f95
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.4
|
Release files / sphinx_nervproject_theme-3.0.3-py3-none-any.whl
| Download URL | sphinx_nervproject_theme-3.0.3-py3-none-any.whl |
|---|---|
| Size | 1.5 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6d2592ee118a6568c214c3fef46d605818677a6ba9cc926533795a556a32f59e
|
|
BLAKE2b-256 checksum How to use checksums |
c5155bf6c2def2acad984c5bd606361115be9da7b1f738578215ff746bbdedfb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.4
|
