Links to source code from include paths

Open
#22 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
github, html, python

Research direction

Start with the documentation generator's handling of synopsis include paths and inspect the generated HTML output. Done means each #include <...> entry at the top of a synopsis links to its corresponding header on GitHub; no file or test is named in the issue.

Written by the indexing model from the issue text.

Description

It would be nice to have #include <...> at the top of the synopsis with a link to the corresponding header on github

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

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from boostorg/docca

All issues in boostorg/docca

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.