987 B
987 B
sphinx_nervproject_theme
A modern responsive theme for python's Sphinx documentation generator based on sphinx_press_theme.
This theme is based on VuePress. It uses Vue.js & Stylus 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
First build web assets:
cd ui
npm run build
Sphinx theme has a soft link to built assets...
Install theme locally with pip install -e .
.
docs
folder contains theme's own documentantion.
cd docs
make clean; make html
Website
To update website:
cd ../press_site rsync -rvi ../sphinx_vuepress_theme/docs/build/html/ . git add --all