default is "."
Projects that don't want tox dir to be "."
can set it to "docs/"
also call to shell must be a
include-raw-escape
ISSUE-ID: RELENG-2520
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Change-Id: I53296072928b1a112213c7d041059c4e0b185812
currently a beta feature, so feedback is encouraged. The script
`docs_script.sh` is not needed, you can copy the files by hand if you prefer.
currently a beta feature, so feedback is encouraged. The script
`docs_script.sh` is not needed, you can copy the files by hand if you prefer.
+The default location of the tox.ini file is in the git repository root
+directory. Optionally your documentation lead may decide to store all tox files
+within the required "docs" subdirectory by setting configuration option
+"tox-dir" to value "docs/" as discussed below.
+
+If your project's tox dir is "docs/" and not "." the tox.ini must be
+reconfigured with the correct relative paths.
+
Once these files are correctly configured in your repository you can test
locally:
Once these files are correctly configured in your repository you can test
locally:
name: rtdv3-global-verify
build-node: centos7-builder-1c-1g
default-version: latest
name: rtdv3-global-verify
build-node: centos7-builder-1c-1g
default-version: latest
jobs:
- rtdv3-global-verify
stream:
jobs:
- rtdv3-global-verify
stream:
- project:
name: rtdv3-global
default-version: latest
- project:
name: rtdv3-global
default-version: latest
build-node: centos7-builder-1c-1g
jobs:
- rtdv3-global
build-node: centos7-builder-1c-1g
jobs:
- rtdv3-global
(default: 10)
:submodule-disable: Disable submodule checkout operation.
(default: false)
(default: 10)
:submodule-disable: Disable submodule checkout operation.
(default: false)
+ :tox-dir: Directory containing the project's read the docs tox.ini
:gerrit_verify_triggers: Override Gerrit Triggers.
:gerrit_trigger_file_paths: Override file paths filter which checks which
file modifications will trigger a build.
:gerrit_verify_triggers: Override Gerrit Triggers.
:gerrit_trigger_file_paths: Override file paths filter which checks which
file modifications will trigger a build.
- inject:
properties-content: |
DEFAULT_VERSION={default-version}
- inject:
properties-content: |
DEFAULT_VERSION={default-version}
- - shell: !include-raw: ../shell/rtdv3.sh
+ - shell: !include-raw-escape: ../shell/rtdv3.sh
- builder:
name: check-info-votes
- builder:
name: check-info-votes
submodule-recursive: true
submodule-disable: false
submodule-timeout: 10
submodule-recursive: true
submodule-disable: false
submodule-timeout: 10
gerrit-skip-vote: false
gerrit_trigger_file_paths:
gerrit-skip-vote: false
gerrit_trigger_file_paths:
- inject:
properties-content: |
TOX_ENVS=docs,docs-linkcheck
- inject:
properties-content: |
TOX_ENVS=docs,docs-linkcheck
- lf-infra-tox-run:
parallel: "true"
- lf-rtdv3-build:
- lf-infra-tox-run:
parallel: "true"
- lf-rtdv3-build:
--- /dev/null
+---
+features:
+ - |
+ Make tox-dir configurable
+ default is "."
+ can now be set to "docs/"