A Sphinx-doc theme based on Vuepress
Project description
A modern responsive theme for python's Sphinx documentation generator.
See it in action on Press Theme own website
This theme is based on VuePress. It uses Vue.js & Stylus managed by webpack (through vue-cli).
Press theme is still in BETA. Contributions are welcome.
Usage
First install the theme:
$ pip install sphinx_press_theme
On Sphinx project's conf.py: set the theme name to press.
html_theme = "press"
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
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.
