https://github.com/schettino72/sphinx_press_theme
A Sphinx-doc theme based on Vuepress
https://github.com/schettino72/sphinx_press_theme
documentation-tool sphinx sphinx-theme vuejs
Last synced: 15 days ago
JSON representation
A Sphinx-doc theme based on Vuepress
- Host: GitHub
- URL: https://github.com/schettino72/sphinx_press_theme
- Owner: schettino72
- License: other
- Created: 2018-07-31T21:32:28.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-03T16:51:54.000Z (about 1 year ago)
- Last Synced: 2025-03-31T21:51:17.824Z (about 2 months ago)
- Topics: documentation-tool, sphinx, sphinx-theme, vuejs
- Language: Vue
- Homepage: https://schettino72.github.io/sphinx_press_site/
- Size: 394 KB
- Stars: 122
- Watchers: 9
- Forks: 35
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES
- Funding: .github/FUNDING.yml
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
# sphinx_press_theme
[](https://pypi.python.org/pypi/sphinx_press_theme)
A modern responsive theme for python's [Sphinx](http://www.sphinx-doc.org) documentation generator.
See it in action on Press Theme own [website](https://schettino72.github.io/sphinx_press_site/)
This theme is based on [VuePress](https://vuepress.vuejs.org/).
It uses [Vue.js](https://vuejs.org/) & [Stylus](http://stylus-lang.com/) managed by
[vite](http://vitejs.dev/).
**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](https://schettino72.github.io/sphinx_press_site/configuration.html).
## 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.py`
- `sphinx_press_theme/__init__.py`
- `sphinx_press_theme/theme.conf`
- `docs/source/conf.py`
- `ui/package.json`
## Website
To update website:
```
cd ../press_site
rsync -rvi ../sphinx_press_theme/docs/build/html/ .
git add --all
```