A Sphinx-doc theme based on Vuepress
Project description
sphinx_press_theme
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 |
|---|---|
| 7.X | latest |
| 4.X | 0.8.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
npm install
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 html
Release
Set version on:
setup.pysphinx_press_theme/__init__.pysphinx_press_theme/theme.confdocs/source/conf.pyui/package.json
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.9.1.tar.gz
(254.7 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_press_theme-0.9.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | eed3fdd8df249b67136b507dfc6a84d1a2c5feca5376960c6d4d28ada4f6cdf7 |
|
| MD5 | ecc6a5791a3d9f0d7fb4be3fadf0847b |
|
| BLAKE2b-256 | cf28fbd928e5dcde4f8acdc7b2b730685dafb35d83437cc0b955332349e12b89 |
