Custom attributes to HTML templates
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
I would like to append the documentation with auxiliary data which would be collected at the time of document generation. (eg. test results).
Expected Behavior
When using pdoc3 programmatically, it would be nice if additional variables could be attached to the Class/Method objects, which could be accessed from within the templates.
Actual Behavior
Currently I'm unable to find any way to add custom variables.
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 examining pdoc3's programmatic document-generation API and the HTML templates used for rendered documentation. Determine how custom variables could be attached to Class or Method objects and exposed to templates; done means generated templates can access caller-provided auxiliary data such as test results.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100