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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinx_press_theme-0.6.0.tar.gz.
File metadata
- Download URL: sphinx_press_theme-0.6.0.tar.gz
- Upload date:
- Size: 60.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4948dd6660a6e13faa5e729f9427d0ecacbef2f5b1a4916e8f7795a86f765e5d
|
|
| MD5 |
9bc17e8c605738ef9b4d6e86e44698f4
|
|
| BLAKE2b-256 |
00d19bed415968dc054a5b1c4873fc73a33ff10dba59c992464ac29348083ecc
|
File details
Details for the file sphinx_press_theme-0.6.0-py3-none-any.whl.
File metadata
- Download URL: sphinx_press_theme-0.6.0-py3-none-any.whl
- Upload date:
- Size: 64.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f6824dd8b33abd822d3c11a9f5f09ed307b0cb824c0f2bfded958c1b4b1bdae7
|
|
| MD5 |
58a25e6b4089562c303df493ddf2b0fc
|
|
| BLAKE2b-256 |
7e2d9bf6a06c2b881f6c1ebdef0426621789a57d15d1d71cf64d4a2a2506f332
|
