A Sphinx-doc theme based on Vuepress
Project description
romnnn_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 underromnnn_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
Hashes for romnnn_sphinx_press_theme-0.5.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ee7829a42345d050034745ac1c512d0d92d92e8e3549478e3dba4952d2f22474 |
|
MD5 | 807bffeb5bb8c0856518341533ee76bb |
|
BLAKE2b-256 | 2f5b041fa2423382d8567cca13882d4f1c11298156e3a7a84b4352b4e95649e5 |