precice / precice/api

Use cppreference TAGFILES when building cpp docs

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

Nobody has claimed this yet.

Dominant language
HTML
Stars
0
Forks
1
PR merge metrics
No merged PRs in 30d

Description

This was implemented in the website before moving here.

https://github.com/precice/precice.github.io/tree/master/doxygen

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.

Research direction

Start with the linked doxygen directory in precice/precice.github.io and compare its existing implementation with the cpp documentation build in this repository. Identify the current build entry point, then make the cpp docs use cppreference TAGFILES; done means the documentation builds with those tag files available.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.