fix(ci): bundle _sphinx_html/index.html into wheel (PS-121)#316
Open
ywatanabe1989 wants to merge 1 commit into
Open
fix(ci): bundle _sphinx_html/index.html into wheel (PS-121)#316ywatanabe1989 wants to merge 1 commit into
ywatanabe1989 wants to merge 1 commit into
Conversation
PS-121 audits that scitex-cloud can serve per-package docs from the in-wheel ``src/<pkg>/_sphinx_html/index.html`` bundle. This repo had no bundle checked in AND ``.gitignore`` actively excluded ``src/*/_sphinx_html/`` — the latter is PS-128, because hatchling's force-include path requires the directory to be tracked. Two-part fix: 1. Drop the ``src/*/_sphinx_html/`` line from .gitignore (PS-128). 2. Commit the freshly-built ``_sphinx_html/`` tree under ``src/scitex/`` (PS-121). The package directory is ``scitex``, not ``scitex_python``. Built locally with sphinx 9.1.0 + the canonical pinned doc stack (sphinx-rtd-theme, myst-parser, sphinx-copybutton, sphinx-autodoc-typehints, plus nbsphinx, matplotlib for gallery). The ``rtd-sphinx-build-on-ubuntu-latest.yml`` workflow already in place will keep the bundle refreshed on every push to main/develop going forward. Note: bundle is ~60 MB because the docs include the matplotlib gallery image set; ``.doctrees/`` and ``__intersphinx_cache__/`` intermediates have been stripped to keep the commit size down. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Owner
Author
|
Note: the failing pytest-matrix jobs here are blocked on PS-170 (umbrella pin freshness), not anything from this PR: That's a stale umbrella-pin issue that needs a separate import-smoke and CLAssistant pass; sphinx, RTD, codecov, etc. are still pending. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
src/scitex/_sphinx_html/so PS-121 stops firingsrc/*/_sphinx_html/from.gitignore(PS-128) — hatchling's force-include requires the bundle to be trackedscitex(notscitex_python) so the bundle lives therePS-121 context
PS-121 in scitex-dev's audit corpus:
Reproducer:
scitex-dev ecosystem audit-all scitex-python --no-version-check→ PS-121 violation.PS-128 was also implicitly violated by
.gitignoreexcludingsrc/*/_sphinx_html/, which would cause hatchling 'Forced include not found' on a clean rebuild.Note on size
Bundle is ~60 MB due to the matplotlib gallery image set baked into
_static/gallery/..doctrees/and__intersphinx_cache__/intermediates have been stripped. Thertd-sphinx-build-on-ubuntu-latest.ymlworkflow already in place will keep the bundle refreshed on every push to main/develop going forward.Test plan
pip wheel .containsscitex/_sphinx_html/index.html🤖 Generated with Claude Code