sphinx-vite-builder 0.0.1a16.dev0__tar.gz

sphinx_vite_builder-0.0.1a16.dev0/.gitignore

@@ -0,0 +1,233 @@
+# Node
+node_modules/
+*.tsbuildinfo
+.vitest-cache/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Generated by sphinx_fonts extension (downloaded at build time)
+docs/_static/fonts/
+docs/_static/css/fonts.css
+
+# Claude Code
+**/CLAUDE.local.md
+**/CLAUDE.*.md
+**/.claude/settings.local.json
+
+# Playwright MCP
+.playwright-mcp/
+
+# Repo-local pytest mirror (do not track — validator-only)
+out/
+
+# Misc
+.vim/
+*.lprof
+pip-wheel-metadata/
+monkeytype.sqlite3

sphinx_vite_builder-0.0.1a16.dev0/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.4
+Name: sphinx-vite-builder
+Version: 0.0.1a16.dev0
+Summary: PEP 517 build backend + Sphinx extension that orchestrates Vite via pnpm
+Project-URL: Repository, https://github.com/git-pull/gp-sphinx
+Author-email: Tony Narlock <tony@git-pull.com>
+License: MIT
+Keywords: backend,build,extension,pep517,pnpm,sphinx,vite
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Sphinx
+Classifier: Framework :: Sphinx :: Extension
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Documentation
+Classifier: Topic :: Documentation :: Sphinx
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Typing :: Typed
+Requires-Python: <4.0,>=3.10
+Requires-Dist: hatchling>=1.0
+Requires-Dist: sphinx>=8.1
+Description-Content-Type: text/markdown
+
+# sphinx-vite-builder
+
+PEP 517 build backend and Sphinx extension that transparently orchestrates
+[Vite](https://vitejs.dev/) builds via [pnpm](https://pnpm.io/) for
+Sphinx-theme packages whose static assets (CSS / JS) are produced by a
+JavaScript toolchain.
+
+## What it solves
+
+A common pattern for modern Sphinx themes is a Python package whose
+`theme/<name>/static/` directory ships built CSS and JS that were
+produced by a JS build tool (Vite, webpack, …). The build artefacts are
+gitignored — they're reproducibly built, not source code. But that
+creates two friction points:
+
+1. **Editable installs and source-tree builds** crash with confusing
+   errors when the static dir is empty (e.g. hatchling's
+   `Forced include not found`).
+2. **CI workflows** must duplicate `pnpm install + vite build` setup
+   steps in every job that touches the package.
+
+`sphinx-vite-builder` owns the Vite invocation end-to-end — exactly the
+way [maturin](https://github.com/PyO3/maturin) owns Cargo for
+Rust+Python packages, or
+[sphinx-theme-builder](https://github.com/pradyunsg/sphinx-theme-builder)
+owns webpack for older Sphinx themes.
+
+## Two heads, one subprocess core
+
+### PEP 517 build backend
+
+Drop-in replacement for `hatchling.build`. Runs `pnpm exec vite build`
+before delegating wheel/sdist construction to hatchling.
+
+```toml
+# packages/your-theme/pyproject.toml
+[build-system]
+requires = ["hatchling>=1.0", "sphinx-vite-builder"]
+build-backend = "sphinx_vite_builder.build"
+backend-path = ["../sphinx-vite-builder/src"]    # for in-tree workspace consumption
+```
+
+The backend short-circuits when `web/` (the Vite source tree) is absent
+— so `pip install <pkg>.tar.gz` from an unpacked sdist works without
+pnpm or Node, because the sdist already contains pre-baked
+`static/`.
+
+### Sphinx extension
+
+Loaded from `conf.py`. Runs Vite as part of the docs lifecycle:
+
+- `sphinx-build` → `pnpm exec vite build` once before the docs build
+- `sphinx-autobuild` → `pnpm exec vite build --watch` as a child process
+  for the lifetime of the autobuild server, with idempotent re-fire on
+  rebuilds and graceful teardown on signal / `atexit`
+
+```python
+# docs/conf.py
+extensions = ["sphinx_vite_builder"]
+sphinx_vite_root = "../packages/your-theme/web"   # path to vite project
+sphinx_vite_mode = "auto"                          # auto | dev | prod | disabled
+```
+
+## Fast-fail diagnostics
+
+When prerequisites are missing the backend / extension raises
+actionable errors rather than producing broken output:
+
+- `PnpmMissingError` — `pnpm` not on `PATH`; hint includes
+  `corepack enable` and the `pnpm.io` install URL
+- `NodeModulesInstallError` — `pnpm install` exited non-zero; hint
+  includes the rerun command
+- `ViteFailedError` — `pnpm exec vite build` exited non-zero; hint
+  surfaces the captured stderr
+
+## License
+
+MIT — see [LICENSE](LICENSE).

sphinx_vite_builder-0.0.1a16.dev0/README.md

@@ -0,0 +1,78 @@
+# sphinx-vite-builder
+
+PEP 517 build backend and Sphinx extension that transparently orchestrates
+[Vite](https://vitejs.dev/) builds via [pnpm](https://pnpm.io/) for
+Sphinx-theme packages whose static assets (CSS / JS) are produced by a
+JavaScript toolchain.
+
+## What it solves
+
+A common pattern for modern Sphinx themes is a Python package whose
+`theme/<name>/static/` directory ships built CSS and JS that were
+produced by a JS build tool (Vite, webpack, …). The build artefacts are
+gitignored — they're reproducibly built, not source code. But that
+creates two friction points:
+
+1. **Editable installs and source-tree builds** crash with confusing
+   errors when the static dir is empty (e.g. hatchling's
+   `Forced include not found`).
+2. **CI workflows** must duplicate `pnpm install + vite build` setup
+   steps in every job that touches the package.
+
+`sphinx-vite-builder` owns the Vite invocation end-to-end — exactly the
+way [maturin](https://github.com/PyO3/maturin) owns Cargo for
+Rust+Python packages, or
+[sphinx-theme-builder](https://github.com/pradyunsg/sphinx-theme-builder)
+owns webpack for older Sphinx themes.
+
+## Two heads, one subprocess core
+
+### PEP 517 build backend
+
+Drop-in replacement for `hatchling.build`. Runs `pnpm exec vite build`
+before delegating wheel/sdist construction to hatchling.
+
+```toml
+# packages/your-theme/pyproject.toml
+[build-system]
+requires = ["hatchling>=1.0", "sphinx-vite-builder"]
+build-backend = "sphinx_vite_builder.build"
+backend-path = ["../sphinx-vite-builder/src"]    # for in-tree workspace consumption
+```
+
+The backend short-circuits when `web/` (the Vite source tree) is absent
+— so `pip install <pkg>.tar.gz` from an unpacked sdist works without
+pnpm or Node, because the sdist already contains pre-baked
+`static/`.
+
+### Sphinx extension
+
+Loaded from `conf.py`. Runs Vite as part of the docs lifecycle:
+
+- `sphinx-build` → `pnpm exec vite build` once before the docs build
+- `sphinx-autobuild` → `pnpm exec vite build --watch` as a child process
+  for the lifetime of the autobuild server, with idempotent re-fire on
+  rebuilds and graceful teardown on signal / `atexit`
+
+```python
+# docs/conf.py
+extensions = ["sphinx_vite_builder"]
+sphinx_vite_root = "../packages/your-theme/web"   # path to vite project
+sphinx_vite_mode = "auto"                          # auto | dev | prod | disabled
+```
+
+## Fast-fail diagnostics
+
+When prerequisites are missing the backend / extension raises
+actionable errors rather than producing broken output:
+
+- `PnpmMissingError` — `pnpm` not on `PATH`; hint includes
+  `corepack enable` and the `pnpm.io` install URL
+- `NodeModulesInstallError` — `pnpm install` exited non-zero; hint
+  includes the rerun command
+- `ViteFailedError` — `pnpm exec vite build` exited non-zero; hint
+  surfaces the captured stderr
+
+## License
+
+MIT — see [LICENSE](LICENSE).

sphinx_vite_builder-0.0.1a16.dev0/pyproject.toml

@@ -0,0 +1,49 @@
+[project]
+name = "sphinx-vite-builder"
+version = "0.0.1a16.dev0"
+description = "PEP 517 build backend + Sphinx extension that orchestrates Vite via pnpm"
+requires-python = ">=3.10,<4.0"
+authors = [
+  {name = "Tony Narlock", email = "tony@git-pull.com"}
+]
+license = { text = "MIT" }
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "License :: OSI Approved :: MIT License",
+  "Framework :: Sphinx",
+  "Framework :: Sphinx :: Extension",
+  "Intended Audience :: Developers",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Topic :: Documentation",
+  "Topic :: Documentation :: Sphinx",
+  "Topic :: Software Development :: Build Tools",
+  "Typing :: Typed",
+]
+readme = "README.md"
+keywords = ["sphinx", "extension", "vite", "pnpm", "pep517", "build", "backend"]
+# Both heads (PEP 517 backend + Sphinx extension) share a single subprocess
+# core. Sphinx is required at runtime for the extension head; hatchling is
+# required at build time of consumer packages but not at runtime, so it
+# stays in [build-system].requires of *consumers* rather than here.
+dependencies = [
+  "hatchling>=1.0",
+  "sphinx>=8.1",
+]
+
+[project.entry-points."sphinx.extensions"]
+"sphinx-vite-builder" = "sphinx_vite_builder"
+
+[project.urls]
+Repository = "https://github.com/git-pull/gp-sphinx"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/sphinx_vite_builder"]

sphinx_vite_builder-0.0.1a16.dev0/src/sphinx_vite_builder/__init__.py

@@ -0,0 +1,43 @@
+"""sphinx-vite-builder: PEP 517 backend + Sphinx extension.
+
+Two orthogonal entry points share one subprocess core:
+
+- :mod:`sphinx_vite_builder.build` — the PEP 517 backend module that
+  consumer packages reference via
+  ``[build-system].build-backend = "sphinx_vite_builder.build"``.
+- :func:`sphinx_vite_builder.setup` — the Sphinx extension entry point
+  that ``conf.py`` references via
+  ``extensions = ["sphinx_vite_builder"]``.
+
+Neither head calls the other; they share the implementation modules
+under :mod:`sphinx_vite_builder._internal`.
+"""
+
+from __future__ import annotations
+
+import typing as t
+
+__version__ = "0.0.1a16.dev0"
+
+if t.TYPE_CHECKING:
+    from sphinx.application import Sphinx
+
+
+def setup(app: Sphinx) -> dict[str, t.Any]:
+    """Register the Sphinx-extension head.
+
+    Phase 1 ships the PEP 517 backend; the extension head's full
+    implementation (vite watch on ``sphinx-autobuild``, one-shot build
+    on ``sphinx-build``) lands in a follow-up commit. For now this
+    stub registers the extension so consumers can declare it without
+    a no-such-module error, and returns the safety metadata.
+    """
+    del app
+    return {
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
+        "version": __version__,
+    }
+
+
+__all__ = ("__version__", "setup")

sphinx_vite_builder-0.0.1a16.dev0/src/sphinx_vite_builder/_internal/__init__.py

@@ -0,0 +1,7 @@
+"""Private implementation modules for ``sphinx-vite-builder``.
+
+Anything imported from this package is *not* part of the stable public
+surface — both heads (PEP 517 backend in :mod:`sphinx_vite_builder.build`
+and Sphinx extension in :mod:`sphinx_vite_builder`) reach in here, but
+external callers should not.
+"""