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.10.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9fb4c6f9b0d213487479f0608d5f2d50b6e18c20f43179794d65a11813f79401 |
|
MD5 | 8eee5e5e88c1d7746d3545541717ca80 |
|
BLAKE2b-256 | 8dcd26ce0a0ce852910e058458f4d12c8599cd81697223bc457d2d83cf8080b8 |
Hashes for romnnn_sphinx_press_theme-0.5.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 191fe39ed5641f7d7bfc69efbb5e498d8a3710a8e9da0a7f1f04c654a6ad54e9 |
|
MD5 | 8886e227e15a5461c76149d9e8094690 |
|
BLAKE2b-256 | ef1fa45eb0f2a68e13cc9857971ae8dc6ce26e4d1c54c22905131e3d3d39de5d |