intoverflow / sphinx_press_theme

A Sphinx-doc theme based on Vuepress

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.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