Merge "Add optional Sphinx build verification"
This commit is contained in:
commit
39c3e4a7fd
|
@ -43,8 +43,8 @@ artcl_collect_list:
|
||||||
|
|
||||||
### Documentation generation related
|
### Documentation generation related
|
||||||
|
|
||||||
* `artcl_gen_docs`: true/false -- If true, the role will use build artifacts
|
* `artcl_gen_docs`: false/true -- If true, the role will use build artifacts
|
||||||
and Sphinx and produce user friendly documentation.
|
and Sphinx and produce user friendly documentation (default: false)
|
||||||
* `artcl_docs_source_dir` -- a local directory that serves as the Sphinx source
|
* `artcl_docs_source_dir` -- a local directory that serves as the Sphinx source
|
||||||
directory.
|
directory.
|
||||||
* `artcl_docs_build_dir` -- A local directory that serves as the Sphinx build
|
* `artcl_docs_build_dir` -- A local directory that serves as the Sphinx build
|
||||||
|
@ -57,6 +57,9 @@ artcl_collect_list:
|
||||||
included in the output documentation.
|
included in the output documentation.
|
||||||
* `table_of_contents` -- List that defines the order in which rST files
|
* `table_of_contents` -- List that defines the order in which rST files
|
||||||
will be laid out in the output documentation.
|
will be laid out in the output documentation.
|
||||||
|
* `artcl_verify_sphinx_build` -- false/true -- If true, verify items defined
|
||||||
|
in `artcl_create_docs_payload.table_of_contents` exist in sphinx generated
|
||||||
|
index.html (default: false)
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
artcl_create_docs_payload:
|
artcl_create_docs_payload:
|
||||||
|
|
|
@ -31,7 +31,7 @@ artcl_collect_list:
|
||||||
- /home/stack/browbeat/results
|
- /home/stack/browbeat/results
|
||||||
- /usr/share/openstack-tripleo-heat-templates
|
- /usr/share/openstack-tripleo-heat-templates
|
||||||
- /tmp/tripleoclient*
|
- /tmp/tripleoclient*
|
||||||
artcl_collect_dir: "{{ lookup('env', 'PWD') }}/collected_files"
|
artcl_collect_dir: "{{ local_working_dir }}/collected_files"
|
||||||
artcl_gzip_only: true
|
artcl_gzip_only: true
|
||||||
artcl_tar_gz: false
|
artcl_tar_gz: false
|
||||||
|
|
||||||
|
@ -58,3 +58,4 @@ artcl_collect_sosreport: false
|
||||||
artcl_gen_docs: false
|
artcl_gen_docs: false
|
||||||
artcl_docs_source_dir: "{{ local_working_dir }}/usr/local/share/ansible/roles/collect-logs/docs/source"
|
artcl_docs_source_dir: "{{ local_working_dir }}/usr/local/share/ansible/roles/collect-logs/docs/source"
|
||||||
artcl_docs_build_dir: "{{ artcl_collect_dir }}/docs/build"
|
artcl_docs_build_dir: "{{ artcl_collect_dir }}/docs/build"
|
||||||
|
artcl_verify_sphinx_build: false
|
||||||
|
|
|
@ -14,3 +14,8 @@
|
||||||
when:
|
when:
|
||||||
- artcl_publish|bool
|
- artcl_publish|bool
|
||||||
- not artcl_collect|bool
|
- not artcl_collect|bool
|
||||||
|
|
||||||
|
- name: Verify Sphinx build
|
||||||
|
shell: grep "{{ item }}" "{{ artcl_collect_dir }}/docs/build/index.html"
|
||||||
|
with_items: "{{ artcl_create_docs_payload.table_of_contents }}"
|
||||||
|
when: artcl_verify_sphinx_build|bool
|
||||||
|
|
Loading…
Reference in New Issue