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.0a2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a7801174a927d141fb3b802d0f2acf106c24e54cb4fa8eb397311b6676f7aed5 |
|
MD5 | 8cb50daf930f0eb7f76006bcaed14a2f |
|
BLAKE2b-256 | 052dfaca1283b1c0f9fa3dbb5be0c449ba783913997c6a1453a6909d63b46008 |
Hashes for sphinx_press_autodoc_theme-0.1.0a2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e230e29fdabd47e847877013c2e6a67e7da91d45ebc19030deea4923f9917a2e |
|
MD5 | b4fe71fb5cecdb8f0f05d53f03a498cf |
|
BLAKE2b-256 | b0d8d198f9b765a0fdcf02fa27cc600a7868f5327510fc8daf40dcf8fbcb5000 |