pre-commit hook usage with virtualenv fails
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
Expected Behavior
After running pre-commit hook, to have generated pdoc output in the directory
Actual Behavior
ModuleNotFoundError is raised when running the pdoc pre-commit hook
Steps to Reproduce
- Install pre-commit framework
- Add pdoc to .pre-commit-config.yaml hooks
- Install pre-commit hooks
- Run the command "pre-commit run --all-files"
Additional info
- pdoc version: 0.9.2
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the failure with the pdoc hook configured in .pre-commit-config.yaml, using pre-commit run --all-files. Trace why the virtualenv cannot import the pdoc module; done means the hook generates pdoc output in the expected directory without raising ModuleNotFoundError.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100