kblicharski / sphinx_press_theme

A Sphinx-doc theme based on Vuepress

Home Page:https://schettino72.github.io/sphinx_press_site/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

html_theme = "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

https://schettino72.github.io/sphinx_press_site/


Languages

Language:Vue 56.1%Language:HTML 16.8%Language:CSS 13.7%Language:Python 7.3%Language:JavaScript 6.1%