Skip to content

fix(ci): install the project itself for docs deploy - #105

Merged
celefthe merged 1 commit into
mainfrom
hotfix-docs-deployment-2
Aug 6, 2026
Merged

fix(ci): install the project itself for docs deploy#105
celefthe merged 1 commit into
mainfrom
hotfix-docs-deployment-2

Conversation

@celefthe

@celefthe celefthe commented Aug 6, 2026

Copy link
Copy Markdown
Member

Follow-up to #104

#104 fixed the lxml-build failure by scoping the install to --only-group docs, but that flag behaves like --only-dev — it excludes the project package itself, not just the other dependency groups. mkdocs-click needs to importlib.import_module("mesoscopy") to render the CLI reference page, so the deploy step still failed on the next push to main:

ERROR   -  Error reading page 'reference/cli-mesoscopy.md': No module named 'mesoscopy'
...
ModuleNotFoundError: No module named 'mesoscopy'

(see run 31112905635)

Fix

-        run: uv run --only-group docs mkdocs gh-deploy --force --clean --verbose
+        run: uv run --no-default-groups --group docs mkdocs gh-deploy --force --clean --verbose

--no-default-groups --group docs still excludes the default dev group (so types/mypy/lxml stay out) but installs the project package (mesoscopy) as usual.

Verification

Locally: uv run --no-default-groups --group docs mkdocs build --verbose completes with exit 0. Confirmed no lxml/mypy in the resolved environment (uv pip list | grep -iE "lxml|mypy" → no match), and mesoscopy imports successfully so the CLI reference page renders.

🤖 Generated with Claude Code

--only-group docs (from #104) fixed the lxml build failure, but it also
skips installing the mesoscopy package itself -- --only-group behaves
like --only-dev and excludes the project. mkdocs-click's CLI reference
page imports mesoscopy directly via importlib, so the deploy step still
failed:

    ModuleNotFoundError: No module named 'mesoscopy'

Use --no-default-groups --group docs instead, which excludes the
dev/types/lxml chain but still installs the project package.

Verified locally: `uv run --no-default-groups --group docs mkdocs build
--verbose` completes with exit 0 and no lxml/mypy in the resolved env.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@celefthe
celefthe merged commit 86895d3 into main Aug 6, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant