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.0a1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f2fed2ac2e468c7f7cc902928ca1f7861add876a63464cffeb8866002628657c |
|
MD5 | 89c6131cf4c7527c4f44e4e56a952f6b |
|
BLAKE2b-256 | 720c3b14696bc90f4eb6dd90e8eb0357bb43a525044eee9be82446c5723e9bfb |
Hashes for sphinx_press_autodoc_theme-0.1.0a1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a91a06d2d0d3a31af71cbe1ddf07453331c15b4f653a03f2e8eebe6571b1e06 |
|
MD5 | 01659962818afec2381241a83528672e |
|
BLAKE2b-256 | ab755ab7a5838aeea8de79784c4ad89d9ac6ddd68cab4e8a417ba388e9bc0124 |