Skip to content

bnubald/eq_sphinx_press_theme

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

76 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

sphinx_press_theme

A modern responsive theme for python's Sphinx documentation generator.

See it in action on Press Theme own website

This theme is based on VuePress. It uses Vue.js & Stylus managed by webpack (through vue-cli).

Press theme is still in BETA. Contributions are welcome.

Usage

First install the theme:

$ pip install sphinx_press_theme

On Sphinx project's conf.py: set the theme name to eq_press.

html_theme = "eq_press"

See details on Sphinx theming docs.

Development

First build web assets:

cd ui
npm run build

Sphinx theme has a soft link to built assets... Install theme locally with pip install -e ..

docs folder contains theme's own documentantion.

cd docs
make clean; make html

Website

To update website:

cd ../press_site rsync -rvi ../sphinx_vuepress_theme/docs/build/html/ . git add --all

About

A Sphinx-doc theme based on Vuepress

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Vue 56.0%
  • HTML 17.0%
  • CSS 13.7%
  • Python 7.2%
  • JavaScript 6.1%