Building Documentation

Documentation is built with rosdoc2 and Sphinx, using the ADI Doctools theme. CI builds and deploys automatically on merge to humble.

Setup

git submodule update --init --recursive

python3 -m venv .venv
source .venv/bin/activate
pip install -r src/adi_ros2/doc/requirements.txt

Full Build

./ci/build_doc.sh

Output is written to _build/docs_output/. Open locally with:

xdg-open _build/docs_output/adi_meta/index.html

Single Package Build

For faster iteration on one package:

rosdoc2 build --package-path src/imu_ros2 --debug

Where to Edit

• Meta-repository docs (src/adi_ros2/doc/): commit here. Add new .rst files to the relevant toctree directive.

• Package docs (src/<package>/doc/): edit in the submodule repo, merge to humble, then update the submodule reference here.