Skip to content

romnn/sphinx_press_theme

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code
This branch is 55 commits ahead, 46 commits behind schettino72:master.

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
ui
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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

Languages

  • Vue 54.5%
  • HTML 16.8%
  • Stylus 12.2%
  • Python 7.8%
  • JavaScript 6.0%
  • CSS 2.2%
  • Makefile 0.5%