Option to generate HTML as a single file
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 2.5k
- Forks
- 228
- PR merge metrics
- No merged PRs in 30d
Description
It would be nice to have the option to generate the documentation into a single HTML or text file.
This would be especially useful for feeding the complete docs (as a single file/text) to an LLM to ask questions about the documented package.
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
No file or test is named in the issue. Start by tracing pdoc's documentation-generation entry point and existing output modes, then determine how complete package documentation is assembled. Done means an option can emit the complete documentation as one HTML or text file, with the behavior covered by relevant existing tests.
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
- Mostly clear
- Newbie friendliness
- 35/100