Readthedocs v2 jobs

[releng/global-jjb.git] / docs / jjb / lf-macros.rst

diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst
index e628179..6404cc9 100644 (file)
--- a/docs/jjb/lf-macros.rst
+++ b/docs/jjb/lf-macros.rst
@@ -259,6 +259,17 @@ ReadTheDocs verify script. Installs and runs tox.
     :doc-dir: Document directory.
     :python-version: Python version.
 
+lf-rtdv2-build
+---------------
+
+ReadTheDocs Version 2 verify and merge scripts.
+This is an update to the read the docs scripts that leverages the new Read the Docs v3 api
+`RTD v3 API <https://docs.readthedocs.io/en/stable/api/v3.html>`_
+Runs tox to verify that the docs are good and then runs the RTDv2 shell script.
+This script handles creating projects as needed, assiging subprojects to the main
+read the docs project and triggering builds to update the documentation.
+
+
 check-info-votes
 ----------------
 
@@ -301,6 +312,23 @@ Runs Jenkins SonarQube plug-in.
 
 Requires ``SonarQube Scanner for Jenkins``
 
+:Optional Parameters:
+    :sonar-task: Sonar task to run. (default: "")
+    :sonar-properties: Sonar configuration properties. (default: "")
+    :sonar-java-opts: JVM options. (default: "")
+    :sonar-additional-args: Additional command line arguments. (default: "")
+
+lf-infra-sonar-with-prescan
+---------------------------
+
+Runs Jenkins SonarQube plug-in after a pre-scan builder, which is defined by
+the macro's caller.
+
+Requires ``SonarQube Scanner for Jenkins``
+
+:Required Parameters:
+    :lf-sonar-prescan: A builder that will run prior to the Sonar scan.
+
 :Optional Parameters:
     :sonar-task: Sonar task to run. (default: "")
     :sonar-properties: Sonar configuration properties. (default: "")