Getting Started¶

Sphinx Press is a modern responsive theme for python’s Sphinx docs.

This theme is based on VuePress. It uses Vue.js & Stylus managed by vite.

Install¶

First install the theme:

$ pip install sphinx_press_theme

Sphinx version compatibility:

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

html_theme = "press"

See details on configuration.

Press theme is still in BETA.

Contributions are welcome.