Overview

rosdoc_lite is a ROS package that wraps documentation tools like doxygen, sphinx, and epydoc, for convenient generation of ROS package documentation.

It also generates online documentation for the ROS wiki.

This package provides only the rosdoc_lite command. It has no supported Python or C++ API.

Change history

0.2.11 (2023-09-07)

• add generate_treeview option (#96) To enable the treeview set in rosdoc.yaml ` - builder: doxygen generate_treeview: YES`
• change to setuptools in accordance with migration guide (#105)
• Add option "required" to builder configs which will cause rosdoc_lite to fail if the builder fails. (#106)
  • Add option "required" to builder configs which will cause rosdoc_lite to fail if the builder fails.
  • Require documentation of this package to finish properly.
  • Added documentation to the added exception from generate_docs.
• Add support for configuring INPUT_FILTER doxygen option (#103)
• Add missing graphviz dep Used by Doxygen for inheritance diagrams.
• Read include_path from config file
  • Removes warning about non existing INCLUDE_PATH. Closes #86
• Bump CMake version to avoid CMP0048
• Contributors: Alexander Gutenkunst, Arne Hitzmann, Felix Ruess, Martin Pecka, Matthijs van der Burgh, Shane Loretz, Tully Foote

0.2.10 (2020-02-07)

• Add mdfile to INPUT
• Use conditional dependencies (#93)
  • Use conditional dependencies for all Python rosdep keys
  • Only depend on epydoc if using Python 2
  • Switch to python?-catkin-pkg-modules since the CLI tools aren't used
  • Python 2 and 3 versions are side-by-side installable
  • Switch to python?-rospkg-modules since the CLI tools aren't used
  • Python 2 and 3 versions are side-by-side installable
• Add mdfile to INPUT
• backwards-compatible fix for python3 API changes
• fix cmake failure when building without tests
• Removes obsolete doxygen options fix cmake failure when building without tests
• enable linking to documentation hosted on third party server
• Update exception handling to Python2.6+ / Python3 syntax
• Fix getting doxygen path when output_folder is defined
• Add unit tests for getting doxygen path
• Better name of function getting the documentation path
• Update exception handling to Python2.6+ / Python3 syntax
• Merge branch 'master' of github.com:jobleier/rosdoc_lite
• enable 'docs_url' pointing to documentation hosted on third party server with external Doxygen documentation using tag files
• Contributors: Alexander Gutenkunst, Finn-Thorben Sell, Johannes Bleier, Matthijs van der Burgh, Paul Dinh, Riku Shigematsu, Shane Loretz, Tully Foote, v4hn

0.2.9 (2019-01-23)

• use yaml.safe_load for untrusted yaml input
• Contributors: Dirk Thomas

0.2.8 (2018-09-17)

• fix top bar on recent doxygen versions
  • on recent doxygen topbar requires jquery
  • fixes documentation generation on ROS melodic
  • see https://www.stack.nl/~dimitri/doxygen/manual/changelog.html#log_1_8_1
• add use_mdfile_as_mainpage option This makes it possible/easier to use a markdown file as mainpage, e.g. the README.md
• remove unsupported option latex_paper_size (#79)
• Expose doxygen parameter GENERATE_QHP
• Contributors: Dirk Thomas, Felix Ruess, Jack O'Quin, Jiri Horner, Levi Armstrong, Tully Foote

0.2.7 (2017-06-02)

• fix import (#74)
• add ability to configure the doxygen parameter EXTRACT_ALL (#72)
• more correct reference to the package website url (#68)
• get rid of HTML static path, so build farm quits complaining
• Contributors: Daniel Stonier, Dirk Thomas, Jack O'Quin, Levi Armstrong

0.2.6 (2016-04-12)

• Support SEARCHENGINE option for doxygen Closes #56
• Contributors: Jack O'Quin, Kentaro Wada

0.2.5 (2015-02-28)

• Add autodoc to sphinx config.
• Use generator specific output folder.

File truncated at 100 lines see the full file