A Sphinx-doc theme based on Vuepress

Navigation

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
Meta
  • License: MIT License (MIT)
  • Author: Eduardo Naufel Schettino <schetino72>
  • Tags sphinx, doc, theme, vue.js
Classifiers

Project description

sphinx_press_theme

PyPI

Please help me keep this project alive ko-fi

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
4.X 0.7.1
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
yarn 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

Website

To update website:

cd ../press_site
rsync -rvi ../sphinx_press_theme/docs/build/html/ .
git add --all

Project details

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
Meta
  • License: MIT License (MIT)
  • Author: Eduardo Naufel Schettino <schetino72>
  • Tags sphinx, doc, theme, vue.js
Classifiers

Release history Release notifications | RSS feed

0.9.1

0.9.0

0.8.0

0.7.3

0.7.2

This version

0.7.1

0.7.0

0.6.1

0.6.0

0.5.1

0.5.0

0.3.0

0.2.0

0.1.1

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_press_theme-0.7.1.tar.gz (59.9 kB view hashes)

Uploaded Source

Built Distribution

sphinx_press_theme-0.7.1-py3-none-any.whl (65.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page