Skip to main content

A Sphinx-doc theme based on Vuepress

Project description

A modern responsive theme for python’s [Sphinx](http://www.sphinx-doc.org) documentation generator.

See it in action on Press Theme own [website](https://schettino72.github.io/sphinx_press_site/)

This theme is based on [VuePress](https://vuepress.vuejs.org/). It uses [Vue.js](https://vuejs.org/) & [Stylus](http://stylus-lang.com/) managed by [webpack](https://webpack.js.org/) (through [vue-cli](https://cli.vuejs.org/)).

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](http://www.sphinx-doc.org/en/master/theming.html#using-a-theme).

## 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

Project details


Download files

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

Source Distribution

sphinx_press_theme-0.5.0.tar.gz (57.5 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page