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 [webpack]( (through [vue-cli](

Press theme is still in ALFA, some core Sphinx features still not available. Contributions are welcome.

## Usage

First install the theme:

` $ pip install sphinx_press_theme `

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

` html_theme = "press" `

See details on [Sphinx theming docs](

## Development

First build web assets:

` cd ui 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; make html `

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
sphinx_press_theme-0.1.1.tar.gz (50.6 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page