<!--- ## 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
[](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
```
Raw data
{
"_id": null,
"home_page": "https://schettino72.github.io/sphinx_press_site/",
"name": "sphinx-press-theme",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "sphinx doc theme vue.js",
"author": "Eduardo Naufel Schettino <schetino72>",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/e7/25/8769ef130d57ea449309a4ee2d76eed653063b5de27d34100822e34e7e93/sphinx_press_theme-0.9.1.tar.gz",
"platform": null,
"description": "<!--- ## LOOKING FOR PROJECT MAINTAINERS\n\nUnfortunately I (the author) do not have time to maintain this project.\n\nIf you are interested just ask me and I will provide admin rights on PyPI and commit access to this repo. --->\n\n# sphinx_press_theme\n\n\n[](https://pypi.python.org/pypi/sphinx_press_theme)\n\n\nA modern responsive theme for python's [Sphinx](http://www.sphinx-doc.org) documentation generator.\n\nSee it in action on Press Theme own [website](https://schettino72.github.io/sphinx_press_site/)\n\n\nThis theme is based on [VuePress](https://vuepress.vuejs.org/).\nIt uses [Vue.js](https://vuejs.org/) & [Stylus](http://stylus-lang.com/) managed by\n[vite](http://vitejs.dev/).\n\n\n\n**Press** theme is still in **BETA**.\nContributions are welcome.\n\n## Install\n\nFirst install the theme:\n\n```\n$ pip install sphinx_press_theme\n```\n\nSphinx version compatibility\n\n|Sphinx |Press Theme|\n|-------|-----------|\n|7.X | latest |\n|4.X | 0.8.0 |\n|3.X | 0.6.1 |\n|2.X | 0.5.1 |\n\n\n## Usage\n\nOn Sphinx project's ``conf.py``: set the theme name to ``press``.\n\n```\nhtml_theme = \"press\"\n```\n\nSee details on [configuration](https://schettino72.github.io/sphinx_press_site/configuration.html).\n\n\n## Development\n\nFirst build web assets:\n\n```\ncd ui\nnpm install\nnpm run build\n```\n\nSphinx theme has a soft link to built assets...\nInstall theme locally with `pip install -e .`.\n\n`docs` folder contains theme's own documentantion.\n\n```\ncd docs\nmake clean html\n```\n\n## Release\n\nSet version on:\n\n- `setup.py`\n- `sphinx_press_theme/__init__.py`\n- `sphinx_press_theme/theme.conf`\n- `docs/source/conf.py`\n- `ui/package.json`\n\n\n## Website\n\nTo update website:\n\n```\ncd ../press_site\nrsync -rvi ../sphinx_press_theme/docs/build/html/ .\ngit add --all\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Sphinx-doc theme based on Vuepress",
"version": "0.9.1",
"project_urls": {
"Documentation": "https://schettino72.github.io/sphinx_press_site/",
"Homepage": "https://schettino72.github.io/sphinx_press_site/",
"Source": "https://github.com/schettino72/sphinx_press_theme",
"Tracker": "https://schettino72.github.io/sphinx_press_site/issues"
},
"split_keywords": [
"sphinx",
"doc",
"theme",
"vue.js"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cf28fbd928e5dcde4f8acdc7b2b730685dafb35d83437cc0b955332349e12b89",
"md5": "ecc6a5791a3d9f0d7fb4be3fadf0847b",
"sha256": "eed3fdd8df249b67136b507dfc6a84d1a2c5feca5376960c6d4d28ada4f6cdf7"
},
"downloads": -1,
"filename": "sphinx_press_theme-0.9.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ecc6a5791a3d9f0d7fb4be3fadf0847b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 83558,
"upload_time": "2024-03-23T01:39:00",
"upload_time_iso_8601": "2024-03-23T01:39:00.525714Z",
"url": "https://files.pythonhosted.org/packages/cf/28/fbd928e5dcde4f8acdc7b2b730685dafb35d83437cc0b955332349e12b89/sphinx_press_theme-0.9.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e7258769ef130d57ea449309a4ee2d76eed653063b5de27d34100822e34e7e93",
"md5": "3c2c8a047d05e0578f79da4f20723ef0",
"sha256": "1643dee7365f7831d1d3971b389b7c255641a7aced75f0681f71574e380046cf"
},
"downloads": -1,
"filename": "sphinx_press_theme-0.9.1.tar.gz",
"has_sig": false,
"md5_digest": "3c2c8a047d05e0578f79da4f20723ef0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 254696,
"upload_time": "2024-03-23T01:39:02",
"upload_time_iso_8601": "2024-03-23T01:39:02.384205Z",
"url": "https://files.pythonhosted.org/packages/e7/25/8769ef130d57ea449309a4ee2d76eed653063b5de27d34100822e34e7e93/sphinx_press_theme-0.9.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-23 01:39:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "schettino72",
"github_project": "sphinx_press_theme",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "sphinx-press-theme"
}
JSON
