fix(docs): resolve package from built checkout - #3653
Merged
Conversation
Worktrees share one .venv via symlink, so `pip install -e .` from any worktree points the editable finder at that worktree for all of them. Sphinx runs with cwd=src_docs, so the old `sys.path` entry (src_docs) did not shadow the finder and autodoc imported the wrong checkout, reporting modules that exist here as missing. Prepend the repo root instead, before `cardano_node_tests` is imported, since the package `__path__` bound there decides submodule lookup. Also drop bold around inline code in leios_tests.md - m2r2 renders the nesting as rst that docutils cannot parse.
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
1 participant
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.
Worktrees share one .venv via symlink, so
pip install -e .from any worktree points the editable finder at that worktree for all of them. Sphinx runs with cwd=src_docs, so the oldsys.pathentry (src_docs) did not shadow the finder and autodoc imported the wrong checkout, reporting modules that exist here as missing.Prepend the repo root instead, before
cardano_node_testsis imported, since the package__path__bound there decides submodule lookup.Also drop bold around inline code in leios_tests.md - m2r2 renders the nesting as rst that docutils cannot parse.