Skip to content

Fix docs deploy: make main.py importable in the mkdocs container - #1558

Open
v1r3n wants to merge 3 commits into
fix/docs-deploy-pythonpathfrom
main
Open

Fix docs deploy: make main.py importable in the mkdocs container#1558
v1r3n wants to merge 3 commits into
fix/docs-deploy-pythonpathfrom
main

Conversation

@v1r3n

@v1r3n v1r3n commented Aug 21, 2026

Copy link
Copy Markdown
Collaborator

mkdocs.yml declares the mermaid custom fence as
!!python/name:main.mermaid_fence, which PyYAML resolves with a plain import main while parsing the config. The deploy action runs the mkdocs console script inside a Docker container, where sys.path[0] is the script's bin directory rather than the checkout, so the import fails and the deploy aborts before building.

Point PYTHONPATH at the container's workspace mount so main.py resolves.

Run 32411004435 failed with:
cannot find module 'main' (No module named 'main')
in "/github/workspace/mkdocs.yml", line 283, column 19

Pull Request type

  • Bugfix
  • Feature
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • WHOSUSING.md
  • Other (please describe):

NOTE: Please remember to run ./gradlew spotlessApply to fix any format violations.

Changes in this PR

Describe the new behavior from this PR, and why it's needed
Issue #

Alternatives considered

Describe alternative implementation you have considered

Enterprise UI Playwright Tests

Every PR automatically triggers the enterprise UI Playwright E2E test suite.
Tests run against conductor-ui main by default. To test against a different
conductor-ui branch, add this line anywhere in the PR description:

conductor-ui-branch: my-feature-branch

v1r3n and others added 3 commits August 20, 2026 19:52
mkdocs.yml declares the mermaid custom fence as
`!!python/name:main.mermaid_fence`, which PyYAML resolves with a plain
`import main` while parsing the config.  The deploy action runs the mkdocs
console script inside a Docker container, where sys.path[0] is the script's
bin directory rather than the checkout, so the import fails and the deploy
aborts before building.

Point PYTHONPATH at the container's workspace mount so main.py resolves.

Run 32411004435 failed with:
  cannot find module 'main' (No module named 'main')
    in "/github/workspace/mkdocs.yml", line 283, column 19
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.

3 participants