sphinx-doc / sphinx-doc/sphinx
C++, alias directive, add recursiveness
Open
Nobody has claimed this yet.
domains:cpp
type:enhancement
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
The alias directive can insert a declaration or a function overload set, with a link to the actual declaration. As discussed in #8141 for the C domain, it can be quite useful to insert nested declarations as well, e.g., to make a synopsis of a class.
There should be a(added in v3.5)maxdepthoption, as the one in thec:alias:.Perhapsthere should be filtering options to include/exclude certain types of declarations. E.g., only list nested type/classes/functions.To make the previous point more usable, there should probably be an "only-nested" option.(added in v3.5, as anorootoption)- Some of the options for the autodoc directives might be interesting to adapt?
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 examining the C++ alias directive and the related C-domain discussion in #8141, then determine which recursive filtering or autodoc options remain intended beyond maxdepth and noroot. Done requires an agreed scope plus implementation and tests for nested declarations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100