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.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3728b3a271e5e145ee4908af1fbc7ba2f310cab34d77c462e579fc553b9a3db3 |
|
MD5 | 7af944f3cefa8850b24260768aac23d5 |
|
BLAKE2b-256 | 11de3e8a8015cc16804eebfe15aa8e6c56e5ceddb0ba6ded7a9b3c03b67319b6 |