Skip to content

Updated docs #444

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: ros2/main
Choose a base branch
from
Open

Updated docs #444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
549b948
Updated docs
NicoBartholomai Feb 27, 2022
79ee8ff
Merge branch 'ros2/main' into ros2/docs-quickfic
NicoBartholomai Mar 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
breathe
breathe==4.33.1
furo<=2021.10.09
sphinxcontrib-plantuml
sphinxcontrib-plantuml==0.22
9 changes: 6 additions & 3 deletions docs/source/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/<username>/java/plantuml.jar'" >> /home/<username>/.bashrc

Where you replace ``<username>`` 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:

Expand Down Expand Up @@ -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
----------------------------

Expand Down