From 1b6b11ba7e27d0cc87cd1f7f63aebee645800bf0 Mon Sep 17 00:00:00 2001 From: clfreville2 Date: Thu, 2 Feb 2023 18:37:13 +0100 Subject: [PATCH 1/3] Add wget to the image [CI SKIP] --- Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index 781dfb7..f941411 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,7 +1,7 @@ FROM debian:bookworm LABEL author="Maxime Batista" -RUN apt update && apt -y install sshpass rsync doxygen nodejs npm xdot xdotool +RUN apt update && apt -y install sshpass rsync doxygen nodejs npm xdot xdotool wget WORKDIR /usr/local RUN npm install docusaurus From af80aa941284447c4a26b60ff5e5a87f20f350e0 Mon Sep 17 00:00:00 2001 From: clfreville2 Date: Thu, 2 Feb 2023 21:12:19 +0100 Subject: [PATCH 2/3] Update mdbook generator [CI SKIP] --- README.md | 3 ++- entrypoint.sh | 2 +- generators/mdbook.sh | 4 +--- 3 files changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6f0d4c9..2800fc9 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ This command generates the documentation and deploys it on your CodeDoc space - `-b --branch [branch]` pattern of branch names to deploy - `-l --loc [dir]` location of the documentation sources root - **required** -- `-t --type [docusaurus|doxygen|swagger]` type of documentation generator to use. - **required** +- `-t --type [docusaurus|doxygen|mdbook|swagger]` type of documentation generator to use. - **required** - `-d --dest [dir]` path to where to put the documentation outputs in your repository's CodeDoc space - **optional !! cannot be absolute !!** Note ! @@ -29,6 +29,7 @@ Usage examples : /entrypoint.sh -l ./documentation/api/api-swagger.yml -t swagger -d api_documentation /entrypoint.sh -l ./documentation/app -t docusaurus -d application_documentation /entrypoint.sh -b main -l ./src/Doxyfile -t doxygen -d sourcecode_documentation +/entrypoint.sh -l ./doc -t mdbook -d book ``` ### How to add a custom documentation generator ? diff --git a/entrypoint.sh b/entrypoint.sh index 4c9ee61..73af274 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -9,8 +9,8 @@ help() { cat < Date: Thu, 2 Feb 2023 22:18:22 +0100 Subject: [PATCH 3/3] Fix typo [CI SKIP] --- generators/mdbook.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/generators/mdbook.sh b/generators/mdbook.sh index 4009c03..24e7e35 100644 --- a/generators/mdbook.sh +++ b/generators/mdbook.sh @@ -3,7 +3,7 @@ GEN_PATH="/docs/book" generate() { if [ ! -f "$1"/book.toml ]; then - echo "doxygen generator error : file $1/book.toml is missing" >&2 + echo "mdbook generator error : file $1/book.toml is missing" >&2 exit 1 fi