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.9.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e777a326bf54c35705ff7a1103e5ab365c7e7c643c7a69954464817b90c169b3 |
|
MD5 | 4f13be1ac6e573475823136e60c82336 |
|
BLAKE2b-256 | 40834e8a1c55f878a9757eea390c5bada386c8e97cdb5398f2f9b94a26275592 |
Hashes for romnnn_sphinx_press_theme-0.5.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eae6f93781198205d1d8a342a2066828378ec41d8a301d8e7c97fdbb3d97c45a |
|
MD5 | a2fd20a630d3575c2df2e7bb2c16ffed |
|
BLAKE2b-256 | f55a42715c139bae8c27cb629904799f7b2231656a0f2f0ba80407e8ce5eb373 |