linguini1 opened a new pull request, #18379: URL: https://github.com/apache/nuttx/pull/18379
## Summary Adds support to render PlantUML syntax into UML diagrams for documentation builds. Fixes #15435. ## Impact Allows retroactive modification of UML diagrams in the documentation to correct mistakes/update with new changes to logic. Avoids storing diagrams as images and allows diffs to be legible in plain-text. Impacts the documentation build in CI here and also the build process for the website release. ## Testing Built documentation using `make autobuild` and `make html` without issue. Verified PlantUML render in browser (see below image): <img width="1279" height="1922" alt="image" src="https://github.com/user-attachments/assets/d70121de-d396-458b-9a2a-9a0fe58e8041"; /> ### NOTE! There are some things about this which may not be optimal. PlantUML (the Java binary) must be installed separately using `sudo apt install plantuml`. I have added this invocation to the Documentation workflow YML file, but it might be preferred to have this tool already baked into the NuttX Linux CI image? I may need help learning how to do that, cc @simbit18 and @lupyuen Additionally, this will impact the website documentation build. I am not incredibly familiar with that build process, but I believe this needs a twin PR to the website repository so that Documentation with PlantUML can be built there. This PR is a draft until the above two issues are resolved. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
