Sphinx Press Theme

0.9.1 verified Fri May 01 auth: no python

A Sphinx-doc theme based on Vuepress. Version 0.9.1 provides a clean, modern theme for Sphinx documentation with a sidebar navigation similar to Vuepress. The library is in maintenance mode with infrequent releases.

pip install sphinx-press-theme

Common errors

error WARNING: html_theme 'sphinx_press_theme' not found ↓

cause The theme package is not installed or the name is misspelled in conf.py.

fix

Run 'pip install sphinx-press-theme' and ensure html_theme = 'sphinx_press_theme' (underscores).

error ModuleNotFoundError: No module named 'sphinx_press_theme' ↓

cause The import is incorrect when using autodoc or similar; no need to import in conf.py for theme only.

fix

Remove the import statement; Sphinx will load the theme automatically if html_theme is set correctly.

Warnings

deprecated The repository is in maintenance mode with no active development; future Sphinx versions may break compatibility. ↓

fix Consider using the official Furo or PyData Sphinx Theme as a modern replacement.

gotcha The theme does not support Sphinx 7.x fully; some features like 'canonical_url' may not work. ↓

fix Pin Sphinx to <7.0 or test with your Sphinx version.

breaking In version 0.8.0, the theme name changed from 'press' to 'sphinx_press_theme'. Old configs break. ↓

fix Set html_theme = 'sphinx_press_theme' instead of 'press'.

Imports

press
wrong
```
press
```
correct
```
import sphinx_press_theme
```
The theme is not imported directly; it is configured in conf.py as 'sphinx_press_theme' via html_theme
sphinx_press_theme
wrong
```
html_theme = 'press' or 'sphinx-press-theme'
```
correct
```
html_theme = 'sphinx_press_theme'
```
In Sphinx conf.py, set html_theme = 'sphinx_press_theme' (underscores, not hyphens)

Quickstart

Minimal setup: add the import and theme options to your Sphinx conf.py.

# conf.py
import sphinx_press_theme

html_theme = 'sphinx_press_theme'
html_theme_options = {
    'repository_url': 'https://github.com/your/repo',
    'repository_branch': 'main',
    'home_page_title': 'My Docs',
    'show_prev_next': False
}