From 549b9487c6f52739fdda9ca88b417c2a2fcb3e40 Mon Sep 17 00:00:00 2001 From: Nico Bartholomai Date: Sun, 27 Feb 2022 17:28:14 -0500 Subject: [PATCH] Updated docs --- docs/requirements.txt | 4 ++-- docs/source/installation.rst | 9 ++++++--- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index e08d2075..edf8077c 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,3 @@ -breathe +breathe==4.33.1 furo<=2021.10.09 -sphinxcontrib-plantuml \ No newline at end of file +sphinxcontrib-plantuml==0.22 diff --git a/docs/source/installation.rst b/docs/source/installation.rst index c21220e7..50adfd5b 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -155,9 +155,7 @@ To enable plantuml from anywhere in your file structure add the following line t .. code-block:: - echo alias plantuml="'java -jar /home//java/plantuml.jar'" >> /home//.bashrc - -Where you replace ```` with your username. For example I would write ``/home/charlie/java/plantuml.jar``. + echo alias plantuml="'java -jar ~/java/plantuml.jar'" >> ~/.bashrc To ensure that it is installed correctly, run ``plantuml -testdot`` and it should output something similar to: @@ -191,6 +189,11 @@ Step 4 - Build Documentation doxygen make html +.. note:: + + If you get an error saying that it cannot build try changing the sphinx command in the Makefile to ``python -m spinx.cmd.build`` + + Step 5 - View Documentation ----------------------------