AcademySoftwareFoundation / xstudio

Apache License 2.0
627 stars 78 forks source link

API documentation doesn't build #27

Open edi-spaghetti opened 1 year ago

edi-spaghetti commented 1 year ago

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.

alatdneg commented 1 year ago

Doc building is currently broke, trying to resolve the dependencies on the various platforms, was just to awkward.

Hopefully when we've time we'll look into making a docker config to do all this. As currently it's painful.

edi-spaghetti commented 1 year ago

in addition Help > Hotkeys does not seem to be built at all

gio: file:///home/centos/xstudio/build/bin/docs/user_docs/getting_started/hotkeys.html: Error when getting information for file “/home/centos/xstudio/build/bin/docs/user_docs/getting_started/hotkeys.html”: No such file or directory