Meta

• License: MIT License (MIT)
• Author: Eduardo Naufel Schettino <schetino72>
• Tags sphinx , doc , theme , vue.js

Classifiers

• Development Status
  • 4 - Beta
• Environment
  • Console
  • Web Environment
• Framework
  • Sphinx
  • Sphinx :: Theme
• Intended Audience
  • Developers
• License
  • OSI Approved :: MIT License
• Operating System
  • OS Independent
• Programming Language
  • Python :: 3
  • Python :: 3.6
  • Python :: 3.7
  • Python :: 3.8
  • Python :: 3.9
• Topic
  • Documentation
  • Software Development :: Documentation

sphinx_press_theme

👁 PyPI

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.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

Verified details

These details have been verified by PyPI

Maintainers

👁 Avatar for aclark from gravatar.com
aclark 👁 Avatar for schettino72 from gravatar.com
schettino72 👁 Avatar for Zulko from gravatar.com
Zulko

Unverified details

These details have not been verified by PyPI

Project links

• Homepage
• Documentation
• Source
• Tracker

• Download URL: sphinx_press_theme-0.9.1.tar.gz
• Upload date: Mar 23, 2024
• Size: 254.7 kB
• Tags: Source
• Uploaded using Trusted Publishing? No
• Uploaded via: twine/5.0.0 CPython/3.12.2

Hashes for sphinx_press_theme-0.9.1.tar.gz

Algorithm	Hash digest
SHA256	1643dee7365f7831d1d3971b389b7c255641a7aced75f0681f71574e380046cf
MD5	3c2c8a047d05e0578f79da4f20723ef0
BLAKE2b-256	e7258769ef130d57ea449309a4ee2d76eed653063b5de27d34100822e34e7e93

See more details on using hashes here.

• Download URL: sphinx_press_theme-0.9.1-py3-none-any.whl
• Upload date: Mar 23, 2024
• Size: 83.6 kB
• Tags: Python 3
• Uploaded using Trusted Publishing? No
• Uploaded via: twine/5.0.0 CPython/3.12.2

Hashes for sphinx_press_theme-0.9.1-py3-none-any.whl

Algorithm	Hash digest
SHA256	eed3fdd8df249b67136b507dfc6a84d1a2c5feca5376960c6d4d28ada4f6cdf7
MD5	ecc6a5791a3d9f0d7fb4be3fadf0847b
BLAKE2b-256	cf28fbd928e5dcde4f8acdc7b2b730685dafb35d83437cc0b955332349e12b89

See more details on using hashes here.