- # Verify job which runs a tox build of the docs project
- #
- # 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)
- # :build-node: The node to run build on.
- # :build-timeout: Timeout in seconds before aborting build. (default: 15)
- # :doc-dir: Directory where tox will place built docs.
- # as defined in the tox.ini (default: docs/_build/html)
- # :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
- # :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_verify_triggers: Override Gerrit Triggers.
- # :gerrit_trigger_file_paths: Override file paths which can be used to
- # filter which file modifications will trigger a build.
- # (default: - compare-type: ANT
- # pattern: '**/*.rst'
- # - compare-type: ANT
- # pattern: '**/conf.py')