Skip to main content

A Sphinx-doc theme based on Vuepress

Project description

romnn's sphinx press theme

Build Status PyPI License PyPI Version PyPI Python versions

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 romnn_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.

Project details


Download files

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

Files for romnnn-sphinx-press-theme, version 0.5.11
Filename, size File type Python version Upload date Hashes
Filename, size romnnn_sphinx_press_theme-0.5.11-py3-none-any.whl (15.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size romnnn_sphinx_press_theme-0.5.11.tar.gz (11.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page