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.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 99c3cf2de9e84a5a607a800dcccb720530d7d6b58b364ae37fed891ba5ac715b |
|
MD5 | 8e6e3b7768e94fdb2860d93af7b0714a |
|
BLAKE2b-256 | 38a4af190872d05277e5be1cdf148a2c441ea83276281767da7b8a7a16dc301e |
Hashes for romnnn_sphinx_press_theme-0.5.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 41277b63b4111f2ea4eb1c0f0257c257fe36d211b98f1d4d6b6b7449a95baba5 |
|
MD5 | 854b2f65394c782b2cbd8212acdbe955 |
|
BLAKE2b-256 | 6ef96a8eedbc010ddec6d24c925bbe062e498a10481da102fc375072aa83e480 |