Package documentation will be treated the same as the generic ROS 2 documentation. Primary requirementsġ.1 All package documentation must be available with the rest of the ROS 2 documentation under a single domain They will be carried out following the initial roll out. The Secondary requirements are also absolute requirements, however they are not necessary to roll out the first stage of implementation. The Primary requirements are those that must be in place for the system to be functional and achieve its purpose. See the diagram below for more context on where documentation will fall under this URL structure:.All documentation will be versioned by ROS 2 distribution names.The per-package documentation plan is an extension of the general ROS 2 documentation project, which introduced some requirements that affect the context of the per-package documentation: Package documentation is indexed alongside ROS 2’s generic content on the docs site.Package documentation (API documentation, other package related content) from the repositories is built on the ROS 2 infrastructure and deployed to the ROS 2 documentation site in an automatic process maintainers can opt in to by adding a doc block to the distribution.yaml.Package maintainers document their packages in their repositories following some recommended guidelines or templates.In general, the vision for the system is: The results will be presented in a consistent way alongside the general ROS 2 documentation, making the documentation as a whole discoverable and predictable. To achieve this we are seeking to standardize a documentation process for ROS 2 packages that will encourage maintainers to robustly document their packages, in turn making ROS 2 package documentation more available. The goal of this design is to make ROS 2 documentation as accessible as possible for all ROS users. ROS 2 is lacking a process for the conglomeration of package documentation.ĭiscoverability for package documentation (and documentation in general) is one of the most frequent user complaints. This article describes the requirements and design of ROS 2’s per-package documentation system.
0 kommentar(er)
