Skip to main content

A fork of Eduardo Naufel Schettino's sphinx_press_theme, with support for sphinx.ext.autodoc

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 ALFA, some core Sphinx features still not available. 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 `

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_autodoc_theme-0.1.0a3.tar.gz (6.9 kB view hashes)

Uploaded source

Supported by

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