A Sphinx-doc theme based on Vuepress
Project description
sphinx_press_theme
Please help me keep this project alive
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.
Install
First install the theme:
$ pip install sphinx_press_theme
Sphinx version compatibility
| Sphinx | Press Theme |
|---|---|
| 3.X | 0.6.0 |
| 2.X | 0.5.1 |
Usage
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
yarn 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 html
Website
To update website:
cd ../press_site
rsync -rvi ../sphinx_press_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.
Source Distribution
Built Distribution
Hashes for sphinx_press_theme-0.6.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f6824dd8b33abd822d3c11a9f5f09ed307b0cb824c0f2bfded958c1b4b1bdae7 |
|
| MD5 | 58a25e6b4089562c303df493ddf2b0fc |
|
| BLAKE2b-256 | 7e2d9bf6a06c2b881f6c1ebdef0426621789a57d15d1d71cf64d4a2a2506f332 |
