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
File details
Details for the file sphinx_press_autodoc_theme-0.1.0a3.tar.gz
.
File metadata
- Download URL: sphinx_press_autodoc_theme-0.1.0a3.tar.gz
- Upload date:
- Size: 6.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.12.1 setuptools/38.2.4 requests-toolbelt/0.8.0 tqdm/4.23.2 CPython/3.6.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 060736a66e2b286909a71b9d0a6c78c98a48da6096008afad86c9e12ea1fe641 |
|
MD5 | cdb62617640f716c7c9bc7118a9bceb9 |
|
BLAKE2b-256 | 9b25600e4a05fc5f2bd9b12ac95cfe0eeae85b848d853fceb46f82fc25816d82 |