-
Notifications
You must be signed in to change notification settings - Fork 0
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
Doxyfile Conf Update #107
Doxyfile Conf Update #107
Conversation
Automatically generate UML Diagrams based on the C++ files and headers. (Ben said this was okay)
@mileskent once this gets merged into master make sure that if it breaks because of lack of graphviz you add the required package to the CI runner |
So add the following to the docs.yml?
And also, does the CI Runner do anything if you're not on ubuntu (I'm not) |
the CI runs are done by github itself on machines in the cloud, nothing locally gets run by your machine. as for if those lines need to get added to the CI job, im not sure, however you can test whether or not the generation will fail by using act |
Make sure autoUML deps are satisfied
Automatically generate UML Diagrams based on the C++ files and headers, as part of https://wiki.hytechracing.org/books/software/page/tc-mux-unit-testing-and-docs-mcu (Ben said this was okay)
graphviz is a dependency for this to work properly; name the same on AUR and nixpkgs. See https://wiki.archlinux.org/title/Graphviz