Skip to content

Update Ament-CMake-Documentation.rst #5409

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

Merged
merged 2 commits into from
Apr 30, 2025
Merged

Update Ament-CMake-Documentation.rst #5409

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
18ee9db
Update Ament-CMake-Documentation.rst
goretkin Apr 28, 2025
1d45885
Update source/How-To-Guides/Ament-CMake-Documentation.rst
goretkin Apr 30, 2025
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
2 changes: 1 addition & 1 deletion source/How-To-Guides/Ament-CMake-Documentation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -455,7 +455,7 @@ The ament index explained

For details on the design and intentions, see `here <https://github.com/ament/ament_cmake/blob/{REPOS_FILE_BRANCH}/ament_cmake_core/doc/resource_index.md>`__

In principle, the ament index is contained in a folder within the install/share folder of your package.
In principle, the ament index is contained in a folder within the `install space <https://colcon.readthedocs.io/en/released/user/what-is-a-workspace.html#install-artifacts>`_.
It contains shallow subfolders named after different types of resources.
Within the subfolder, each package providing said resource is referenced by name with a "marker file".
The file may contain whatever content necessary to obtain the resources, e.g. relative paths to the installation directories of the resource, it may also be simply empty.
Expand Down