From c2494ace391aec04f864667454ce8573cc39ad3b Mon Sep 17 00:00:00 2001 From: Thanh Ha Date: Sun, 15 Oct 2017 15:03:02 -0400 Subject: [PATCH] Add missing documentation to rtd jobs Change-Id: I1e0f97f3824aef4c18c4975931b388a41686e8bd Signed-off-by: Thanh Ha --- jjb/lf-rtd-jobs.yaml | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/jjb/lf-rtd-jobs.yaml b/jjb/lf-rtd-jobs.yaml index 64c6dac5..9feaec19 100644 --- a/jjb/lf-rtd-jobs.yaml +++ b/jjb/lf-rtd-jobs.yaml @@ -74,18 +74,22 @@ # # Required parameters: # + # :build-node: The node to run build on. + # :jenkins-ssh-credential: Credential to use for SSH. (Generally should + # be configured in defaults.yaml) # :rtd-project: This is the name of the project on ReadTheDocs.org. # # Optional parameters: # # :branch: Git branch to fetch for the build. (default: master) # :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7) - # :build-node: The node to run build on. # :build-timeout: Timeout in seconds before aborting build. (default: 15) # :git-url: base URL of git project. (default: https://github.com) # :project-pattern: Project to trigger build against. (default: **) # :stream: Keyword that can be used to represent a release code-name. # Often the same as the branch. (default: master) + # :submodule-recursive: Whether to checkout submodules recursively. + # (default: true) # # :gerrit_merge_triggers: Override Gerrit Triggers. # :gerrit_trigger_file_paths: Override file paths which can be used to @@ -172,7 +176,13 @@ name: lf-rtd-verify # Verify job which runs a tox build of the docs project # - # Optional parameters: + # Required Parameters: + # + # :build-node: The node to run build on. + # :jenkins-ssh-credential: Credential to use for SSH. (Generally should + # be configured in defaults.yaml) + # + # Optional Parameters: # # :branch: Git branch to fetch for the build. (default: master) # :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7) -- 2.16.6