Option to generate HTML as a single file
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
I've seen HTML websites that simulate multiple pages in a single page. It would be nice to have an option in pdoc3 to generate a single .html file that would function the same way as the current multi-page option. Does anyone know of a reason this wouldn't be possible with pdoc3?
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 existing multi-page HTML generation behavior and how its documentation output is assembled. The work is complete when pdoc3 offers an option that produces one .html file while preserving the behavior of the current multi-page output.
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
- 30/100