sphinx-vite-builder 0.0.1a16.dev4__tar.gz → 0.0.1a18.dev0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (17) hide show
  1. {sphinx_vite_builder-0.0.1a16.dev4 → sphinx_vite_builder-0.0.1a18.dev0}/AGENTS.md +8 -1
  2. {sphinx_vite_builder-0.0.1a16.dev4 → sphinx_vite_builder-0.0.1a18.dev0}/PKG-INFO +8 -3
  3. {sphinx_vite_builder-0.0.1a16.dev4 → sphinx_vite_builder-0.0.1a18.dev0}/README.md +7 -2
  4. {sphinx_vite_builder-0.0.1a16.dev4 → sphinx_vite_builder-0.0.1a18.dev0}/pyproject.toml +1 -1
  5. {sphinx_vite_builder-0.0.1a16.dev4 → sphinx_vite_builder-0.0.1a18.dev0}/src/sphinx_vite_builder/__init__.py +1 -1
  6. {sphinx_vite_builder-0.0.1a16.dev4 → sphinx_vite_builder-0.0.1a18.dev0}/src/sphinx_vite_builder/_internal/vite.py +1 -2
  7. {sphinx_vite_builder-0.0.1a16.dev4 → sphinx_vite_builder-0.0.1a18.dev0}/.gitignore +0 -0
  8. {sphinx_vite_builder-0.0.1a16.dev4 → sphinx_vite_builder-0.0.1a18.dev0}/CLAUDE.md +0 -0
  9. {sphinx_vite_builder-0.0.1a16.dev4 → sphinx_vite_builder-0.0.1a18.dev0}/src/sphinx_vite_builder/_internal/__init__.py +0 -0
  10. {sphinx_vite_builder-0.0.1a16.dev4 → sphinx_vite_builder-0.0.1a18.dev0}/src/sphinx_vite_builder/_internal/bus.py +0 -0
  11. {sphinx_vite_builder-0.0.1a16.dev4 → sphinx_vite_builder-0.0.1a18.dev0}/src/sphinx_vite_builder/_internal/config.py +0 -0
  12. {sphinx_vite_builder-0.0.1a16.dev4 → sphinx_vite_builder-0.0.1a18.dev0}/src/sphinx_vite_builder/_internal/errors.py +0 -0
  13. {sphinx_vite_builder-0.0.1a16.dev4 → sphinx_vite_builder-0.0.1a18.dev0}/src/sphinx_vite_builder/_internal/hooks.py +0 -0
  14. {sphinx_vite_builder-0.0.1a16.dev4 → sphinx_vite_builder-0.0.1a18.dev0}/src/sphinx_vite_builder/_internal/process.py +0 -0
  15. {sphinx_vite_builder-0.0.1a16.dev4 → sphinx_vite_builder-0.0.1a18.dev0}/src/sphinx_vite_builder/build.py +0 -0
  16. {sphinx_vite_builder-0.0.1a16.dev4 → sphinx_vite_builder-0.0.1a18.dev0}/src/sphinx_vite_builder/hatch_plugin.py +0 -0
  17. {sphinx_vite_builder-0.0.1a16.dev4 → sphinx_vite_builder-0.0.1a18.dev0}/src/sphinx_vite_builder/py.typed +0 -0
@@ -168,13 +168,20 @@ motivated this whole package). The required steps are:
168
168
  - uses: actions/setup-node@v6
169
169
  with:
170
170
  node-version: 22
171
- cache: pnpm
172
171
  ```
173
172
 
174
173
  If you find yourself removing those, ask: "is the source-build path
175
174
  still going to produce a populated `static/` in the wheel?" The
176
175
  answer must be yes.
177
176
 
177
+ `cache: pnpm` is intentionally omitted from the recipe so it stays
178
+ correct in *consumer* CI as well — setup-node's pnpm cache lookup
179
+ expects a `pnpm-lock.yaml` at the repo root, which only exists in
180
+ this workspace, not in downstream repos that pull a gp-sphinx-family
181
+ package transitively from a git source. The workspace's own
182
+ `release.yml` may keep `cache: pnpm` for a small speed-up since the
183
+ lockfile lives at the repo root here.
184
+
178
185
  ## When in doubt
179
186
 
180
187
  - Read the full plan at gp-sphinx issue #28.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: sphinx-vite-builder
3
- Version: 0.0.1a16.dev4
3
+ Version: 0.0.1a18.dev0
4
4
  Summary: PEP 517 build backend + Sphinx extension that orchestrates Vite via pnpm
5
5
  Project-URL: Repository, https://github.com/git-pull/gp-sphinx
6
6
  Author-email: Tony Narlock <tony@git-pull.com>
@@ -103,7 +103,6 @@ config (before the Python build step that triggers this backend):
103
103
  - uses: actions/setup-node@v6
104
104
  with:
105
105
  node-version: 22
106
- cache: pnpm
107
106
  ```
108
107
 
109
108
  The error includes the resolved vite-root path, the platform-specific
@@ -254,9 +253,15 @@ search-discoverability.
254
253
  - uses: actions/setup-node@v6
255
254
  with:
256
255
  node-version: 22
257
- cache: pnpm
258
256
  ```
259
257
 
258
+ `cache: pnpm` is intentionally omitted: setup-node's pnpm cache
259
+ lookup expects a `pnpm-lock.yaml` at the consumer repo root, which
260
+ fails when sphinx-vite-builder runs from a transitive git source
261
+ (the lockfile lives inside the source-built package's checkout, not
262
+ the consumer repo). Workspaces that own their own `pnpm-lock.yaml`
263
+ at the repo root may add `cache: pnpm` for a small speed-up.
264
+
260
265
  ### CircleCI (`CIRCLECI=true`)
261
266
 
262
267
  ```yaml
@@ -76,7 +76,6 @@ config (before the Python build step that triggers this backend):
76
76
  - uses: actions/setup-node@v6
77
77
  with:
78
78
  node-version: 22
79
- cache: pnpm
80
79
  ```
81
80
 
82
81
  The error includes the resolved vite-root path, the platform-specific
@@ -227,9 +226,15 @@ search-discoverability.
227
226
  - uses: actions/setup-node@v6
228
227
  with:
229
228
  node-version: 22
230
- cache: pnpm
231
229
  ```
232
230
 
231
+ `cache: pnpm` is intentionally omitted: setup-node's pnpm cache
232
+ lookup expects a `pnpm-lock.yaml` at the consumer repo root, which
233
+ fails when sphinx-vite-builder runs from a transitive git source
234
+ (the lockfile lives inside the source-built package's checkout, not
235
+ the consumer repo). Workspaces that own their own `pnpm-lock.yaml`
236
+ at the repo root may add `cache: pnpm` for a small speed-up.
237
+
233
238
  ### CircleCI (`CIRCLECI=true`)
234
239
 
235
240
  ```yaml
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "sphinx-vite-builder"
3
- version = "0.0.1a16.dev4"
3
+ version = "0.0.1a18.dev0"
4
4
  description = "PEP 517 build backend + Sphinx extension that orchestrates Vite via pnpm"
5
5
  requires-python = ">=3.10,<4.0"
6
6
  authors = [
@@ -24,7 +24,7 @@ import typing as t
24
24
  if t.TYPE_CHECKING:
25
25
  from sphinx.application import Sphinx
26
26
 
27
- __version__ = "0.0.1a16.dev4"
27
+ __version__ = "0.0.1a18.dev0"
28
28
 
29
29
  logger = logging.getLogger(__name__)
30
30
  logger.addHandler(logging.NullHandler())
@@ -125,8 +125,7 @@ _CI_SETUP_RECIPES: dict[str, str] = {
125
125
  version: 10
126
126
  - uses: actions/setup-node@v6
127
127
  with:
128
- node-version: 22
129
- cache: pnpm""",
128
+ node-version: 22""",
130
129
  ),
131
130
  "circleci": textwrap.dedent(
132
131
  """\