LOOKING FOR PROJECT MAINTAINERS
Unfortunately I (the author) do not have time to maintain this project.
If you are interested just ask me and I will provide admin rights on PyPI and commit access to this repo.
sphinx_press_theme
A modern responsive theme for python's Sphinx documentation generator.
See it in action on Press Theme own website
This theme is based on VuePress. It uses Vue.js & Stylus managed by vite.
Press theme is still in BETA. Contributions are welcome.
Install
First install the theme:
$ pip install sphinx_press_theme
Sphinx version compatibility
| Sphinx | Press Theme |
|---|---|
| 4.X | latest |
| 3.X | 0.6.1 |
| 2.X | 0.5.1 |
Usage
On Sphinx project's conf.py: set the theme name to press.
html_theme = "press"
See details on configuration.
Development
First build web assets:
cd ui
yarn build
Sphinx theme has a soft link to built assets...
Install theme locally with pip install -e ..
docs folder contains theme's own documentantion.
cd docs
make clean html
Release
Set version on:
setup.pysphinx_press_theme/__init__.pysphinx_press_theme/theme.confdocs/source/conf.py
Website
To update website:
cd ../press_site
rsync -rvi ../sphinx_press_theme/docs/build/html/ .
git add --all
1 maintainer
Metadata
1 maintainer
Release files for sphinx-press-theme-dark 0.8.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_press_theme_dark-0.8.2.tar.gz | 71.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_press_theme_dark-0.8.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 139.8 kB
Release files / sphinx_press_theme_dark-0.8.2.tar.gz
| Download URL | sphinx_press_theme_dark-0.8.2.tar.gz |
|---|---|
| Size | 71.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4190bdc337fdfc6f595d2c7cfd41013be893e79135fae62c5b758ab6e2ee7b63
|
|
BLAKE2b-256 checksum How to use checksums |
d040faf6df8a162ec36b8a1efae278484c1e8f757f9b1103499e99d45bde229c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.8.10
|
Release files / sphinx_press_theme_dark-0.8.2-py3-none-any.whl
| Download URL | sphinx_press_theme_dark-0.8.2-py3-none-any.whl |
|---|---|
| Size | 67.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
26d30e847e322ec344ae087a766b2b0731cb4c1cfcde84ec52868da1b13cd341
|
|
BLAKE2b-256 checksum How to use checksums |
fc24d0b2eef2ebd77890f3ac5798b5e2f321ec85c8e1ed7a698fbd8c939999bb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.8.10
|
