C++ Class Diagrams#147
Conversation
ilateur
left a comment
ilateur
left a comment
There was a problem hiding this comment.
I was unable to generate these images myself (on monster5). I tried installing clang-uml via conda but I got errors with make html (I did not try to solve them). I am not allowed to install clang-uml via the package manager there, but Lars tried and failed that install.
It would be best if everything was included inside the environment.yml as a self-contained package that works for everybody, but somehow that did not work on Windows?
The actual diagrams look nice, although I wasn't able to judge them on the website. Sadly I don't think we should merge this if only 1 person is able to successfully run it.
There was a problem hiding this comment.
Just checking, these are generated files, but are themselves not needed by the website?
| ``` | ||
|
|
||
| The documentation can then be found at `docs/_build/html/index.html`. | ||
| The documentation can then be found at `docs/_build/html/index.html`. However, to generate the class diagrams you should be on a Linux device and first install [clang-uml](https://github.com/bkryza/clang-uml/tree/master) otherwise they will not be generated. |
|
I will move this back to draft and see if I can fix the issues. |
|
It was successfully built on monster5! Though, I must admit it's hard to keep an overview when all boxes are that large. Either you see the connections, but can't read anything, or you zoom in to read, but can only look at a single class. |
3 participants
This PR would automatically generate class diagrams each time the website gets build and they will be added to the website. There are a total of 6 diagrams to avoid a cluttered image.
Class Diagrams
Parameters
Magnetics
Strayfield
Time Integration
Domain
Utilities