catkin_tools_document

此包是ROS包的实验性文档构建器，类似于rosdoc_lite。它在以下方面有所不同

• 它被实现为catkin_tools插件，因此它自然地融入开发工作流程，并利用该包的能力，包括包发现、依赖关系解析和并行执行。
• 因为它在workspace级别而不是按包操作，所以它可以自动处理依赖包之间的doxygen链接。
• 它自动链接到cppreference以获取标准库函数和头文件。
• 它对doxygen进行双重构建，一次不带链接以获取仅包含包内符号的XML输出，一次带所有链接以获取HTML输出。这避免了rosdoc_lite产生的重复符号警告。

演示

如果使用pip，建议使用virtualenv。或者，您可以从我的PPA获取Ubuntu或Debian的系统包（2022-03-17：目前PPA损坏/未更新）。

pip install catkin_tools_document
mkdir -p catkin_ws/src && cd catkin_ws
rosinstall_generator ros_base --deps --tar --rosdistro noetic > src/.rosinstall
wstool up -t src
catkin document

现在在您选择的浏览器中打开 catkin_ws/docs/index.html。

发布

# Upload to pypi
python setup.py sdist bdist_wheel
twine upload dist/*

# Upload to launchpad. Need to rebuild with signing as the built-in capability in stdeb
# isn't released yet, and I couldn't get dpkg-sig to work either for a post-build signature.
python setup.py --command-packages=stdeb.command sdist_dsc --upstream-version-suffix=focal --suite focal
cd deb_dist/*
dpkg-buildpackage -S
dput ppa:mikepurvis/catkin ../*_source.changes