Skip to content

Commit

Permalink
[TechDocs] Enhance PlantUML support in the techdocs container to incl…
Browse files Browse the repository at this point in the history
…ude external puml or pu files

Issue #20184

Signed-off-by: Lavanya Sainik <lavanya.sainik@ericsson.com>
  • Loading branch information
lavanya-sainik-ericsson committed Sep 28, 2023
1 parent a782f9a commit 68f65c0
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,11 @@ RUN pip install --upgrade pip && pip install mkdocs-techdocs-core==1.2.2
# error (OSError: [Errno 8] Exec format error: 'plantuml') by using the
# following RUN command instead:
# RUN echo '#!/bin/sh\n\njava -jar '/opt/plantuml.jar' ${@}' >> /usr/local/bin/plantuml

# When adding TechDocs with plantUml diagrams, to refer external puml or pu files in any markdown file,
# eg. '!include <referencedFileName.puml>', need to include diagrams directory eg. docs in the classpath.
# Use following RUN command instead:
# RUN echo $'#!/bin/sh\n\njava -Dplantuml.include.path=${diagramDir} -jar '/opt/plantuml.jar ' ${@}' >> /usr/local/bin/plantuml
RUN echo $'#!/bin/sh\n\njava -jar '/opt/plantuml.jar' ${@}' >> /usr/local/bin/plantuml
RUN chmod 755 /usr/local/bin/plantuml

Expand Down

0 comments on commit 68f65c0

Please sign in to comment.