Skip to content

README.md

Latest commit

 

History

History
59 lines (41 loc) · 1.79 KB

README.md

File metadata and controls

59 lines (41 loc) · 1.79 KB
Raw

eProsima DDS Enabler docs

This package generates the DDS Enabler documentation. Here it can be seen the online documentation hosted in readthedocs. This packages is powered by sphinx.

Documentation generation

Dependencies

Before being able to build the documentation, some dependencies need to be installed:

sudo apt update
sudo apt install -y \
    doxygen \
    python3 \
    python3-pip \
    python3-venv \
    python3-sphinxcontrib.spelling \
    imagemagick
pip3 install -U -r src/ddsenabler_docs/docs/requirements.txt

Build documentation

In order to install this package independently, use the following command:

colcon build --packages-select ddsenabler_docs

To generate the documentation locally, build the docs package with the docs flag enabled: BUILD_DOCS

colcon build --packages-select ddsenabler_docs --cmake-args -DBUILD_DOCS=ON

Once the build completes, the generated HTML files can be found under build/ddsenabler_docs/html

In order to compile and execute the package tests, a specific CMake option is required: BUILD_DOCS_TESTS.

colcon build --packages-select ddsenabler_docs --cmake-args -DBUILD_DOCS_TESTS=ON
colcon test --packages-select ddsenabler_docs --event-handler console_direct+

Library documentation

This documentation is focused on the user manual for installing and working with DDS Enabler. To learn about the repository structure, design decisions, development guidelines, etc., each package is documented separately and the source code is commented using Doxygen format. In directory .dev there is a generic README.md with the main information needed by a developer.