add suggestions to link test page to workflow docs

nest · Nov 13, 2023 · 4a73806 · 4a73806
1 parent 09b8faa
commit 4a73806
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 3 deletions.
diff --git a/...eveloper_space/workflows/documentation_workflow/user_documentation_workflow.rst b/...eveloper_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 <https://plantuml.com/download>`_ (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 <https://docs.readthedocs.io/en/stable/intro/import-guide.htmli>`_
 for more information.
+
+.. toctree::
+   :hidden:
+
+   /testuml
diff --git a/doc/htmldoc/testuml.rst b/doc/htmldoc/testuml.rst
@@ -1,14 +1,22 @@
-:orphan:
+.. _test_uml:
+
+Test uml page
+-------------
+
+Two diagrams should render on this page.
+
+**Basic example:**
 
-Test page
----------
 
 .. uml::
 
    Alice -> Bob: Hi!
    Alice <- Bob: How are you?
 
 
+**C4 example:**
+
+
 .. uml::
 
  !include <C4/C4_Context>