Documentation

Generating Documentation using rosdoc2

rosdoc2 is a package that can generate documentation for your project based on comments in your source files. It needs little or no configuration setup. All you have to do is to install rosdoc2 and its dependencies. Follow the instructions below to generate a doxygen based documentation.

Install rosdoc2

• Clone the repo to some location in your computer git clone https://github.com/ros-infrastructure/rosdoc2.git

• From the root of this repo execute pip install --user --upgrade .

• You may have to add the location of the binary installation to the PATH variable

• Intasll doxygen sudo apt install doxygen

Generate Docs

• Navigate one folder level deep from the root of the repository into ros2_template_pkg folder cd ros2_template_pkg

• Create a folder called doc and move into it mkdir doc and cd doc

• Execute the command to generate the docs. This let's rosdoc2 know to place the documentation in this folder(where you are currently executing the command from) and provides the path of the package which is one folder level above. rosdoc2 build --package-path ..