Allow detection of pdoc3 execution
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
Feature request
Allow detection of pdoc3 being executed, e.g. allowing for customizing module paths etc. on pdoc3 runtime. For example through setting an environment variable that can be checked in the module.
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 reviewing how pdoc3 execution and module paths are currently handled. Define a runtime signal, such as an environment variable, that modules can check to detect pdoc3 execution and customize their paths. Done means the signal is available during pdoc3 runs and its intended behavior is documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100