Skip to main content

Plugin for catkin_tools to enable building workspace documentation.

Project description

catkin_tools_document

This package is an experimental documentation-builder for ROS packages, similar to rosdoc_lite. It differs in the following ways:

  • It's implemented as a catkin_tools plugin, so it fits naturally into the developer workflow, and piggy-backs off that package's capabilities as far as package discovery, dependency resolution, and parallel execution.
  • Because it operates at the workspace level rather than package-by-package, it automatically handles linking up doxygen between dependent packages.
  • It automatically links to cppreference for standard library functions and headers.
  • It double-builds for doxygen, once without links to get the XML output of in-package symbols only, and once with all links to get the HTML output. This avoids the duplicate symbol warnings which rosdoc_lite produces.

Demonstration

Using a virtualenv is recommended if using pip. Alternatively, you can get a system package for Ubuntu or Debian on my PPA (2022-03-17: PPA is broken/not updated for now).

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

Now open up catkin_ws/docs/index.html in the browser of your choice.

Release

# 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

catkin_tools_document-0.5.2.tar.gz (90.5 kB view details)

Uploaded Source

Built Distribution

catkin_tools_document-0.5.2-py3-none-any.whl (102.4 kB view details)

Uploaded Python 3

File details

Details for the file catkin_tools_document-0.5.2.tar.gz.

File metadata

  • Download URL: catkin_tools_document-0.5.2.tar.gz
  • Upload date:
  • Size: 90.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.22.0 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.60.0 importlib-metadata/4.11.3 keyring/18.0.1 rfc3986/2.0.0 colorama/0.4.3 CPython/3.8.10

File hashes

Hashes for catkin_tools_document-0.5.2.tar.gz
Algorithm Hash digest
SHA256 aa6d99313d74781be4de44df8648b0718fff81b999463f6bca6cdb8aa4daa464
MD5 7675372caee4cf54a8fe19a807dc8a9f
BLAKE2b-256 520e3875903147a3bfc954ab42a33901792e875d3d879063e04c135c9e06e30d

See more details on using hashes here.

File details

Details for the file catkin_tools_document-0.5.2-py3-none-any.whl.

File metadata

  • Download URL: catkin_tools_document-0.5.2-py3-none-any.whl
  • Upload date:
  • Size: 102.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.22.0 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.60.0 importlib-metadata/4.11.3 keyring/18.0.1 rfc3986/2.0.0 colorama/0.4.3 CPython/3.8.10

File hashes

Hashes for catkin_tools_document-0.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d72af4af8e9d7cfe7f3afdd1681b258bd5d21a45a30c17dff6a06a5a5193e432
MD5 c31f4463a8f63ac2d2d9921b28cbc6a8
BLAKE2b-256 f9dac49d3ace002bfa640551ef3be2c756d29ab85c49637f5316421b36fa0205

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page