Building a Jenkins Documentation Job Locally

wjwwood · May 1, 2017, 9:15pm

That is documented here:

ros-infrastructure/ros_buildfarm/blob/master/doc/jobs/doc_jobs.rst#run-the-doc-job-locally

*doc* jobs
==============

A *doc* job is used for generating API documentation as well as extracting
information from the package manifests.


Different types of documentation
--------------------------------

Each *doc build files* can have one of three specific documentation types:

* the **rosdoc_lite** type operates on doc repositories.
  For each *doc build file* with that type a separate Jenkins view is created.
  Each *doc* job operates on a specific branch of a single doc repository and
  is triggered based on a timer (once every few days).
  After a partial build step (more about this see below) it uses
  `rosdoc_lite <https://github.com/ros-infrastructure/rosdoc_lite>`_ to run
  various tools for the generation step.

This file has been truncated. show original

Though I haven’t tried it myself.

Topic		Replies	Views
Documentation for build.ros2.org Buildfarm ci , ros_buildfarm	4	4910	May 31, 2021
New Guide on docs.ros.org: Writing Per-Package Documentation ROS General	5	742	April 20, 2024
Doc jobs for metapackages? Buildfarm	2	4435	July 23, 2021
Big workspace management Buildfarm	6	1168	August 20, 2016
New release of the ros_buildfarm package (version 3.0.0) Buildfarm ros_buildfarm	0	779	June 7, 2019

Building a Jenkins Documentation Job Locally

Related topics