Include pages (e.g. notebooks)
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
It would be nice to be able to include pages to the docs with the same menu as in the index.
Expected Behavior
Actual Behavior
Currently, I export the notebook to HTML with a template that contains the hard-coded TOC:
Additional info
- pdoc version:
0.6.3
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 pdoc's documentation-generation and navigation code, then compare it with the linked nbconvert custom-template approach. The work is done when notebook or other included pages appear in the generated docs using the same menu as the index; no specific source files or tests are named in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook, python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100