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

Doxyfile Conf Update #107

Merged
merged 4 commits into from
Sep 28, 2024
Merged

Doxyfile Conf Update #107

merged 4 commits into from
Sep 28, 2024

Conversation

mileskent
Copy link
Member

@mileskent mileskent commented Sep 24, 2024

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

Comerm28 and others added 3 commits September 21, 2024 14:57
Automatically generate UML Diagrams based on the C++ files and headers. (Ben said this was okay)
@RCMast3r
Copy link
Collaborator

@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

@mileskent
Copy link
Member Author

@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?

    - name: Install dependencies
      run: sudo apt-get update && sudo apt-get install -y graphviz

And also, does the CI Runner do anything if you're not on ubuntu (I'm not)

@RCMast3r

@RCMast3r
Copy link
Collaborator

@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?

    - name: Install dependencies
      run: sudo apt-get update && sudo apt-get install -y graphviz

And also, does the CI Runner do anything if you're not on ubuntu (I'm not)

@RCMast3r

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

@mileskent
Copy link
Member Author

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

@RCMast3r For me, sudo act -j gen_docs fails even on master. "::error::Action failed with "Cannot read properties of undefined (reading 'fork')""

Make sure autoUML deps are satisfied
@mileskent mileskent merged commit f98ae41 into master Sep 28, 2024
1 of 2 checks passed
@mileskent mileskent deleted the MCUDoxygen branch September 28, 2024 23:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants