sphinx-doc / sphinx-doc/sphinx
Allow alias of arbitrary domain objects
Open
Nobody has claimed this yet.
type:enhancement
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
https://github.com/sphinx-doc/sphinx/issues/4981 adds a way for C++ domain declarations to be displayed multiple times using aliases. I really like to have this for arbitrary domains.
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 reading the linked Sphinx issue #4981 to understand the existing C++ domain alias behavior, then identify the common domain declaration entry points it could extend to. Done means arbitrary domain objects can be displayed through aliases with behavior consistent across domains.
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
- 25/100