From e621cb84c73e81ac880cd4715a0c54b681ce0332 Mon Sep 17 00:00:00 2001 From: Shrukan Date: Sat, 17 Feb 2024 20:27:20 -0700 Subject: [PATCH] Add plantuml support to the documentation --- .gitignore | 2 ++ Dockerfile | 5 ++++- README.md | 5 +---- docs/Doxyfile.in | 2 +- 4 files changed, 8 insertions(+), 6 deletions(-) diff --git a/.gitignore b/.gitignore index 9ecf617..e433591 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,5 @@ builddir/ subprojects/** !subprojects/*.wrap !subprojects/.clang-format + +.cache/ diff --git a/Dockerfile b/Dockerfile index ac6f343..73da839 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,7 +1,7 @@ FROM gcc:13 # Install build tools -RUN apt-get update && apt-get install -y python3 python3-pip ninja-build clang-format clang-tidy gdb graphviz git curl zsh \ +RUN apt-get update && apt-get install -y python3 python3-pip ninja-build clang-format clang-tidy gdb openjdk-17-jdk-headless graphviz git curl zsh \ && rm -rf /var/lib/apt/lists/* RUN pip install --break-system-packages meson gcovr @@ -19,6 +19,9 @@ RUN wget -O mold.tar.gz https://github.com/rui314/mold/releases/download/v2.4.0/ ENV CC_LD=mold ENV CXX_LD=mold +# Install plantuml +RUN wget --progress=bar:force:noscroll https://github.com/plantuml/plantuml/releases/download/v1.2024.3/plantuml-mit-1.2024.3.jar -O /usr/local/bin/plantuml.jar + # Install node for actions RUN curl -fsSL https://deb.nodesource.com/setup_current.x | bash - && apt-get install -y nodejs diff --git a/README.md b/README.md index af835aa..f044700 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,7 @@ ${REPO_DESCRIPTION} ## Build Instructions -The provided Docker image includes all necessary dependencies to build and debug -C/C++ applications. While the main build system is Meson, a Justfile is provided -for convenience. With dependencies installed, or inside the Docker container, run -the following: +The provided Docker image includes all necessary dependencies to build and debug C/C++ applications. While the main build system is Meson, a Justfile is provided for convenience. With dependencies installed, or inside the Docker container, run the following: ``` Available recipes: diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in index a8d7bb7..eaf3528 100644 --- a/docs/Doxyfile.in +++ b/docs/Doxyfile.in @@ -2808,7 +2808,7 @@ DIAFILE_DIRS = # a preprocessing step. Doxygen will generate a warning when it encounters a # \startuml command in this case and will not generate output for the diagram. -PLANTUML_JAR_PATH = +PLANTUML_JAR_PATH = /usr/local/bin/plantuml.jar # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a # configuration file for plantuml.