mirror of
https://github.com/introlab/rtabmap_ros.git
synced 2026-10-04 16:57:46 +08:00
matlabbe
61edb4ee85
* Initial tests * more tests * More in-depth deskew() testing * slightly less verbose clamping corruption warning * added tf buffer related tests * added remaining tests * Added rosdoc2, improve tests when we require sync of odom stamp and sensor stamp * cleanup doc * fixing ci * rtabmap_util tests and doc * Added db_player tests * Added MapsManager tests * Added map_assembler tests * Documenting node first draft * relative links * Fixed british->usa english style. Reviewed all md files. * added link to install ros1 * updated badges * added Iron * added ubuntu * added codecov * updated coverage ci * fixing rosdep * updated ci cov job * ci bump * fixing cov ci * small doc cleanup
36 lines
1.2 KiB
YAML
36 lines
1.2 KiB
YAML
## Configuration for rosdoc2, the documentation generator used by docs.ros.org.
|
|
## Regenerate the annotated default with:
|
|
## rosdoc2 default_config --package-path rtabmap_util
|
|
## Build the docs locally with:
|
|
## rosdoc2 build --package-path rtabmap_util --output-directory doc_output
|
|
|
|
## This 'attic section' self-documents this file's type and version.
|
|
type: 'rosdoc2 config'
|
|
version: 1
|
|
|
|
---
|
|
|
|
settings:
|
|
## Generate the standard index page from package.xml (description, maintainer,
|
|
## license, links) and a table of contents for the builders below.
|
|
generate_package_index: true
|
|
|
|
## This is an ament_cmake package, so doxygen runs on the public headers by
|
|
## default and there are no Python modules to document.
|
|
always_run_doxygen: false
|
|
always_run_sphinx_apidoc: false
|
|
|
|
builders:
|
|
## Doxygen parses the public C++ API out of include/.
|
|
- doxygen: {
|
|
name: 'rtabmap_util Public C/C++ API',
|
|
output_dir: 'generated/doxygen'
|
|
}
|
|
## Sphinx renders the landing page and pulls the Doxygen XML in through
|
|
## breathe/exhale so the API is browsable alongside the narrative docs.
|
|
- sphinx: {
|
|
name: 'rtabmap_util',
|
|
doxygen_xml_directory: 'generated/doxygen/xml',
|
|
output_dir: ''
|
|
}
|