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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinx_press_autodoc_theme-0.1.0a0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 24116bcaa1f074034a3c0d1dd52beaef8dfe0e9bb1294de9137836baf16b90c0 |
|
MD5 | 86c0b9632a68ac2fd9a7615bc806d596 |
|
BLAKE2b-256 | fe37bae0d058013d0a24b8a24495c11e72f802eb1c9cdc277886ecfc6c49e8a7 |
Hashes for sphinx_press_autodoc_theme-0.1.0a0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ff33a69c21f57ce495c69f8485df58060a94d22400ddac80ece87eb2ca76586 |
|
MD5 | e2c1f15b452416d8f9896da9be1d111e |
|
BLAKE2b-256 | 81b7e9009da9f6b00631a1ec040494e98abb2a033f52cb4e1063a3d63775c44e |