Mechanism for custom type-link inclusion
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- cpp
- Domain
- documentation, tooling
Research direction
Start in include/docca/doxygen.xsl around the hardcoded type-links at line 1572. Trace how those links are currently selected, then determine how an input or inclusion file could supply links for project-specific types. Done means project authors can provide custom type links without editing the hardcoded list.
Written by the indexing model from the issue text.
Description
We need a way for projects using docca to provide information about specific types in the project that have associated docs. The project authors should be able to provide an input or inclusion file that provides links we want to add for specified custom types. Docca currently has some hardcoded type-links here, but these types need to be moved out and the mechanism needs to be made generic.
- Dominant language
- Python
- Stars
- 20
- Forks
- 25
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
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.
More from boostorg/docca
-
Difficulty 3/5 1-2 days Newbie friendliness 38/100
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
Similar issues
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
simonw/sqlite-utils#872 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100