A Sphinx-doc theme based on Vuepress
Project description
romnn's sphinx press theme
See a live demo.
This is a fork of the original sphinx_press_theme by schettino72, which is a modern and responsive theme for python's Sphinx documentation generator.
The theme is based on VuePress and uses Vue.js+ Stylus with webpack.
Usage
First install the theme:
pip install romnnn_sphinx_press_theme
To use the theme, set the theme name to press
in your sphinx project's conf.py
:
html_theme = "press"
For more information, see the Sphinx theming docs.
Development
-
Build the web assets:
cd ui npm run build
The generated
theme.css
,theme.js
andtheme-vendors.js
will be linked into the theme underromnn_sphinx_press_theme/static
. -
Install theme locally:
pip install -e .
-
Review the theme by building the theme's documentation under
docs/
:make docs
Generated html will be in
docs/build/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 romnnn_sphinx_press_theme-0.5.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4fefe92de0f31f42a44eaf422561f954a6d3d1dab10ec03dce7b979687fec9cc |
|
MD5 | 4d5a423df991b0996aab744d71d893ee |
|
BLAKE2b-256 | fd34ca3d00df141b380baa35987dcb1b1c16fdf66ede5a19fb633a574615c74a |
Hashes for romnnn_sphinx_press_theme-0.5.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd109f005fe08816dd2eaf5fe93bad3a72c0fa1395496aacf380672403ae523a |
|
MD5 | 2341f4d2b522e1ccab9fff5029415233 |
|
BLAKE2b-256 | e25aabcf124688503bdab4477acaadd41dbf8b98a2db9e7e56a8ffdb1b79202b |