diff --git a/doc/htmldoc/developer_space/workflows/documentation_workflow/user_documentation_workflow.rst b/doc/htmldoc/developer_space/workflows/documentation_workflow/user_documentation_workflow.rst index be757b369f..d8d40f612f 100644 --- a/doc/htmldoc/developer_space/workflows/documentation_workflow/user_documentation_workflow.rst +++ b/doc/htmldoc/developer_space/workflows/documentation_workflow/user_documentation_workflow.rst @@ -130,6 +130,9 @@ If you use pip, install ``pandoc`` from your platform's package manager (e.g. ap - Download the `plantuml jar file `_ (Minimum version is 1-2023-10) - Move the jar file to ``/tmp/plantuml.jar`` + - To see if plantuml diagrams render correctly after building the documentation you can take a look + at our :ref:`test_uml`. + Edit and create pages ~~~~~~~~~~~~~~~~~~~~~~ @@ -242,3 +245,8 @@ on Read the Docs, you can set up your own account and link it with your Github a See `this guide `_ for more information. + +.. toctree:: + :hidden: + + /testuml diff --git a/doc/htmldoc/testuml.rst b/doc/htmldoc/testuml.rst index 6a6559f1d9..edfbce3d27 100644 --- a/doc/htmldoc/testuml.rst +++ b/doc/htmldoc/testuml.rst @@ -1,7 +1,12 @@ -:orphan: +.. _test_uml: + +Test uml page +------------- + +Two diagrams should render on this page. + +**Basic example:** -Test page ---------- .. uml:: @@ -9,6 +14,9 @@ Test page Alice <- Bob: How are you? +**C4 example:** + + .. uml:: !include