A Sphinx-doc theme based on Vuepress
Project description
LOOKING FOR PROJECT MAINTAINERS
Unfortunately I (the author) do not have time to maintain this project.
If you are interested just ask me and I will provide admin rights on PyPI and commit access to this repo.
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 |
---|---|
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.py
sphinx_press_theme/__init__.py
sphinx_press_theme/theme.conf
docs/source/conf.py
Website
To update website:
cd ../press_site
rsync -rvi ../sphinx_press_theme/docs/build/html/ .
git add --all
Project details
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_dark-0.8.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4190bdc337fdfc6f595d2c7cfd41013be893e79135fae62c5b758ab6e2ee7b63 |
|
MD5 | c9f7bfd5460db1689b28ed78e80145fd |
|
BLAKE2b-256 | d040faf6df8a162ec36b8a1efae278484c1e8f757f9b1103499e99d45bde229c |
Hashes for sphinx_press_theme_dark-0.8.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 26d30e847e322ec344ae087a766b2b0731cb4c1cfcde84ec52868da1b13cd341 |
|
MD5 | 6dc6bde5341eeaab4c37878e3a0dedb9 |
|
BLAKE2b-256 | fc24d0b2eef2ebd77890f3ac5798b5e2f321ec85c8e1ed7a698fbd8c939999bb |