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.
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 |
On Sphinx project's conf.py: set the theme name to press.
html_theme = "press"
See details on configuration.
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
Set version on:
setup.pysphinx_press_theme/__init__.pysphinx_press_theme/theme.confdocs/source/conf.pyui/package.jsonTo update website:
cd ../press_site
rsync -rvi ../sphinx_press_theme/docs/build/html/ .
git add --all
FAQs
A Sphinx-doc theme based on Vuepress
We found that sphinx-press-theme demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.