Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API documentation doesn't build #27

Open
edi-spaghetti opened this issue Feb 22, 2023 · 2 comments
Open

API documentation doesn't build #27

edi-spaghetti opened this issue Feb 22, 2023 · 2 comments
Labels
bug Something isn't working build Related to building project

Comments

@edi-spaghetti
Copy link

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.

@edi-spaghetti edi-spaghetti changed the title API docuementation doesn't build API documentation doesn't build Feb 22, 2023
@alatdneg alatdneg added bug Something isn't working build Related to building project labels Mar 1, 2023
@alatdneg
Copy link
Contributor

alatdneg commented Mar 1, 2023

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
Copy link
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working build Related to building project
Projects
None yet
Development

No branches or pull requests

2 participants