Skip to main content

Transparent Vite + pnpm orchestration for Sphinx theme asset pipelines

Project description

gp-sphinx-vite

Transparent Vite + pnpm orchestration for Sphinx theme asset pipelines.

A Sphinx extension that spawns pnpm exec vite build --watch from builder-inited so theme authors iterating templates and SCSS get fresh furo.css / furo.js on disk without remembering a separate vite build command. The extension is a no-op in production (when sphinx-build runs without the autobuild driver), so wheels published to PyPI never carry a Node runtime requirement.

Status

Skeleton — only setup() and config-value registration are wired up. Subprocess management (ViteProcess), the asyncio↔threading bridge, and the actual spawn/teardown lifecycle (with signal handling and idempotent re-spawn for sphinx-autobuild) land in subsequent commits.

Usage (eventual)

# conf.py
extensions = ["gp_sphinx_vite"]

# Optional. Defaults to "auto": dev iff SPHINX_AUTOBUILD env var is set
# or sys.argv[0] ends with "sphinx-autobuild"; prod (no-op) otherwise.
gp_sphinx_vite_mode = "auto"

# Optional. Path to the directory containing package.json + vite.config.ts.
# Defaults to <theme directory>/web (resolved relative to the active theme).
gp_sphinx_vite_root = None

Config

Name Type Default
gp_sphinx_vite_mode Literal["auto", "dev", "prod"] "auto"
gp_sphinx_vite_root str | None None (auto-detect)

Project details


Download files

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

Source Distribution

gp_sphinx_vite-0.0.1a16.dev1.tar.gz (14.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gp_sphinx_vite-0.0.1a16.dev1-py3-none-any.whl (15.4 kB view details)

Uploaded Python 3

File details

Details for the file gp_sphinx_vite-0.0.1a16.dev1.tar.gz.

File metadata

  • Download URL: gp_sphinx_vite-0.0.1a16.dev1.tar.gz
  • Upload date:
  • Size: 14.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for gp_sphinx_vite-0.0.1a16.dev1.tar.gz
Algorithm Hash digest
SHA256 6d39a6f45aa97a469e66f1e45b87db8ea8060e8a0acf69c86ec16e45b328e2f3
MD5 94224364181d0a15ea83ed4c76ab9b5c
BLAKE2b-256 c05dab43a281ee78be4ee903d3022c4e6887eeba8fd25fc8d0ebfb6cfbdeb07a

See more details on using hashes here.

Provenance

The following attestation bundles were made for gp_sphinx_vite-0.0.1a16.dev1.tar.gz:

Publisher: release.yml on git-pull/gp-sphinx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gp_sphinx_vite-0.0.1a16.dev1-py3-none-any.whl.

File metadata

File hashes

Hashes for gp_sphinx_vite-0.0.1a16.dev1-py3-none-any.whl
Algorithm Hash digest
SHA256 50de431676a6390ab28e05ee9b774a9011e96d8256f45971eaa536a38379848c
MD5 c3bdc39d07c5648fa65b0cc11bd2b086
BLAKE2b-256 bd9cb3181255fe8ee4c53f306c72f62994fc07f328251e29ace38b8b24ccb532

See more details on using hashes here.

Provenance

The following attestation bundles were made for gp_sphinx_vite-0.0.1a16.dev1-py3-none-any.whl:

Publisher: release.yml on git-pull/gp-sphinx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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