Exclude some files completely?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.5k
- Forks
- 228
- PR merge metrics
- No merged PRs in 30d
Description
Problem Description
I've got some Python 2.7 stuff in my project and while they function fine in the intended environment (Maya), pdoc can't execute them under 3.9 and I can't generate docs for any of the package despite just one file being problematic and hundreds being fine.
Proposal
A way to flag files as ignore completely, so we don't run into errors in "pdoc\extract.py", line 211, in load_module"
Alternatives
I've no idea sadly :(
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 reading pdoc/extract.py around line 211, where load_module fails on incompatible Python 2.7 files. Trace how package files are selected and determine where an ignore-file option would be applied; done means the problematic file is skipped while documentation generation continues for the remaining package.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100