Support for headings to organize functions into sections
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
firstly, this program is awesome. thank you.
this may be asking too much from pdoc3, but in my code i usually have comment sections which are like markdown headings to organize the functions. kind of like a module-level doc-string. is there anyway to implement this with pdoc? i dont want to explicitly write a list of functions like i have to do with sphinx, because thats annoying, and easy to forget some.
example use case is a simple project with little more than a __init__.py. but with many functions it is nice to have headings to organise them. thoughts?
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
The issue names no files, tests, or entry points. First clarify how comment sections or Markdown-like headings should be detected and rendered in pdoc3, then define completion as organizing documented functions into those sections without requiring an explicit function list.
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
- Needs clarification
- Newbie friendliness
- 35/100