Skip to main content

A Sphinx-doc theme based on Vuepress

Project description



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.


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


On Sphinx project's set the theme name to press.

html_theme = "press"

See details on configuration.


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


Set version on:

  • sphinx_press_theme/
  • sphinx_press_theme/theme.conf
  • docs/source/
  • ui/package.json


To update website:

cd ../press_site
rsync -rvi ../sphinx_press_theme/docs/build/html/ .
git add --all

Project details

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)

Uploaded Source

Built Distribution

sphinx_press_theme-0.9.1-py3-none-any.whl (83.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page