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 | latest |
| 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
Release
Set version on:
setup.pysphinx_press_theme/__init__.pysphinx_press_theme/theme.confdocs/source/conf.py
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.7.3-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f1ec7c5717d3695af2d0f49fb36f1e97115479d0d2d3a42b0d1f55b1ea61a800 |
|
| MD5 | 0c404fc58d2b1c29d3b915bdd034f6be |
|
| BLAKE2b-256 | fdee771089988ca8b2d60753bc963d4400d66d91608e62ef31e35f50ff608b04 |
