AcademySoftwareFoundation / AcademySoftwareFoundation/xstudio

API documentation doesn't build

Open
#27 2 comments 0 reactions 0 assignees View on GitHub
bug build
Dominant language
C++
Stars
769
Forks
129
Avg merge
9d 1m
Merged PRs (30d)
10

Description

I got a build running on centos7, however the API documentation accessed from Help > User Documentation takes me to a local docs file (file:///home/centos/xstudio/build/bin/docs/user_docs/index.html). From there I can read all the xSTUDIO User Guide documentation, but all API documentation shows a `warning: doxygenfile: Unable to find project ‘xStudio’ in breathe_projects dictionary` for every class/module.

Contributor guide

Open the contributing guide

Research direction

Start by reproducing the API documentation from Help > User Documentation and inspect the generated file at file:///home/centos/xstudio/build/bin/docs/user_docs/index.html. The work is done when the API class and module pages no longer show the reported Breathe project warning.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
build-system, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.