NVIDIA / NVIDIA/cuda-quantum

latex should be installed in build documentation environment

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

Nobody has claimed this yet.

documentation stale-notified
Dominant language
C++
Stars
1.1k
Forks
456
Avg merge
1d 22h
Merged PRs (30d)
165

Description

Doxygen caves in when trying to use mathematical formula in the documentation bot. The bot doesn't have latex installed.

https://github.com/NVIDIA/cuda-quantum/actions/runs/7424320296/job/20204242631?pr=1072

Contributor guide

Open the contributing guide

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 GitHub Actions run and identify the build documentation environment used by the documentation bot. Ensure LaTeX is available there, then rerun the documentation build with a mathematical formula to confirm Doxygen completes successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, latex
Domain
ci-cd, documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.