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 |
|---|---|
| 7.X | latest |
| 4.X | 0.8.0 |
| 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
npm install
npm run 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.pyui/package.json
Website
To update website:
cd ../press_site
rsync -rvi ../sphinx_press_theme/docs/build/html/ .
git add --all
3 maintainers
Metadata
3 maintainers
Release files for sphinx-press-theme 0.9.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinx_press_theme-0.9.1.tar.gz | 254.7 kB | Without provenance | Details for sphinx_press_theme-0.9.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinx_press_theme-0.9.1-py3-none-any.whl | Python 3 | none | any | Details for sphinx_press_theme-0.9.1-py3-none-any.whl |
Total release size: 338.3 kB
Release files / sphinx_press_theme-0.9.1.tar.gz
| Download URL | sphinx_press_theme-0.9.1.tar.gz |
|---|---|
| Size | 254.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1643dee7365f7831d1d3971b389b7c255641a7aced75f0681f71574e380046cf
|
|
BLAKE2b-256 checksum How to use checksums |
e7258769ef130d57ea449309a4ee2d76eed653063b5de27d34100822e34e7e93
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.12.2
|
Release files / sphinx_press_theme-0.9.1-py3-none-any.whl
| Download URL | sphinx_press_theme-0.9.1-py3-none-any.whl |
|---|---|
| Size | 83.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
eed3fdd8df249b67136b507dfc6a84d1a2c5feca5376960c6d4d28ada4f6cdf7
|
|
BLAKE2b-256 checksum How to use checksums |
cf28fbd928e5dcde4f8acdc7b2b730685dafb35d83437cc0b955332349e12b89
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.12.2
|
Security for sphinx-press-theme 0.9.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
