Skip to main content

romnn's sphinx press theme

Build Status PyPI License PyPI Version PyPI Python versions

See a live demo.

This is a fork of the original sphinx_press_theme by schettino72, which is a modern and responsive theme for python's Sphinx documentation generator.

The theme is based on VuePress and uses Vue.js+ Stylus with webpack.

Usage

First install the theme:

pip install romnnn_sphinx_press_theme

To use the theme, set the theme name to press in your sphinx project's conf.py:

html_theme = "press"

For more information, see the Sphinx theming docs.

Development

  1. Build the web assets:

    cd ui
    npm run build
    

    The generated theme.css, theme.js and theme-vendors.js will be linked into the theme under romnn_sphinx_press_theme/static.

  2. Install theme locally:

    pip install -e .
    
  3. Review the theme by building the theme's documentation under docs/:

    make docs
    

    Generated html will be in docs/build/html.

Metadata

Release files for romnnn-sphinx-press-theme 0.5.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for romnnn-sphinx-press-theme 0.5.11
File Size Uploaded
romnnn_sphinx_press_theme-0.5.11.tar.gz 11.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for romnnn-sphinx-press-theme 0.5.11
File Interpreter ABI Platform
romnnn_sphinx_press_theme-0.5.11-py3-none-any.whl Python 3 none any Details

Total release size: 27.6 kB

Release files / romnnn_sphinx_press_theme-0.5.11.tar.gz

Download URL romnnn_sphinx_press_theme-0.5.11.tar.gz
Size 11.9 kB
Tags Source
SHA-256 checksum
How to use checksums
385b3a9ce865ca995b43765e5730078c214db2563f96d17ab12ca7673134ca03
BLAKE2b-256 checksum
How to use checksums
7c35870c6296e32f9ab8ac3ee8630363e28ce359e10a73d1fc7a83f1d4a92209
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

Release files / romnnn_sphinx_press_theme-0.5.11-py3-none-any.whl

Download URL romnnn_sphinx_press_theme-0.5.11-py3-none-any.whl
Size 15.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
eb9c84bab62ad916a6232f841aac2ed9d4a8b02e14f20023c030dca1c2c23224
BLAKE2b-256 checksum
How to use checksums
c509207a1be092abc99df9175935c42f57a000f92cf49f4d923e51ff76c9f408
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

Release history Release notifications | RSS feed

This release

0.5.11 This release

2 release files

0.5.9

2 release files

0.5.8

2 release files

0.5.7

2 release files

0.5.6

1 release file

0.5.5

1 release file

0.5.4

1 release file

0.5.3

1 release file

0.5.2

1 release file

0.5.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page