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 8d2c1975..51ca67bb 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -159,9 +159,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: @@ -195,6 +193,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 ----------------------------