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 vite.
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 |
|---|---|
| 4.X | 0.7.0 |
| 3.X | 0.6.1 |
| 2.X | 0.5.1 |
Usage
On Sphinx project's conf.py: set the theme name to press.
html_theme = "press"
See details on configuration.
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
sphinx_press_theme-0.7.0.tar.gz
(60.0 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_press_theme-0.7.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | aab51e2971e8fdcf22433a16f1663f522abc0e25988d627f50b6410ae1b5abee |
|
| MD5 | b1263d3599d95a1462e67be22c18a5e0 |
|
| BLAKE2b-256 | 4aa3aec66569022d099e48c82ad3a57557334eb82cb1106467ed7297feb9980e |
