maximmenshikov / sphinx_press_theme

A sphinx-doc theme based on vuepress

romnnn_sphinx_press_theme

See a live demo.

This is a fork of the original sphinx_press_theme by schettino72, which is a modern and responsive theme for python's Sphinx documentation generator.

The theme is based on VuePress and uses Vue.js+ Stylus with webpack.

Usage

First install the theme:

pip install romnnn_sphinx_press_theme

To use the theme, set the theme name to press in your sphinx project's conf.py:

html_theme = "press"

For more information, see the Sphinx theming docs.

Development

1. Build the web assets:

   cd ui
   npm run build

   The generated theme.css, theme.js and theme-vendors.js will be linked into the theme under romnnn_sphinx_press_theme/static.

2. Install theme locally:

   pip install -e .

3. Review the theme by building the theme's documentation under docs/:

   make docs

   Generated html will be in docs/build/html.