![]() |
ddsrouter_docs package from dds-router repoddsrouter_core ddsrouter_test ddsrouter_yaml ddsrouter_docs ddsrouter_tool ddsrouter_yaml_validator |
Package Summary
Tags | No category tags. |
Version | 0.0.0 |
License | Apache 2.0 |
Build type | CMAKE |
Use | RECOMMENDED |
Repository Summary
Checkout URI | https://github.com/eprosima/dds-router.git |
VCS Type | git |
VCS Version | main |
Last Updated | 2022-12-20 |
Dev Status | UNMAINTAINED |
CI status | No Continuous Integration |
Released | UNRELEASED |
Tags | No category tags. |
Contributing |
Help Wanted (0)
Good First Issues (0) Pull Requests to Review (0) |
Package Description
Additional Links
Maintainers
- Raul Sánchez-Mateos
- Javier París
- Juan López
Authors
eProsima DDS Router docs
This package generates the DDS Router 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/ddsrouter/docs/requirements.txt
Build documentation
In order to install this package independently, use the following command:
colcon build --packages-select ddsrouter_docs
In order to compile and execute the package tests, a specific CMake option is required: BUILD_DOCS_TESTS
.
colcon build --packages-select ddsrouter_docs --cmake-args -DBUILD_DOCS_TESTS
colcon test --packages-select ddsrouter_docs --event-handler console_direct+
Library documentation
This documentation is focused on the user manual for installing and working with DDS Router.
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.