summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoman Gorshunov <roman.gorshunov@att.com>2018-07-11 14:05:50 +0200
committerScott Hussey <sh8121@att.com>2018-08-07 07:44:32 -0500
commitcd0c023425c62118e9d1aaa5b321297b231226c7 (patch)
tree302874adbae1f8cd979a08961d4267924fa9b836
parent7c90da14b4b3f48f953c411d93421d570577a628 (diff)
Add docs build and publish
Added local documentation build and publishing to the readthedocs. Change-Id: Iab06eb55d7859916f2b938191a5415ac57be0f44
Notes
Notes (review): Code-Review+2: Felipe Monteiro <felipe.monteiro@att.com> Code-Review+2: Bryan Strassner <bryan.strassner@gmail.com> Workflow+1: Bryan Strassner <bryan.strassner@gmail.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Wed, 15 Aug 2018 16:58:44 +0000 Reviewed-on: https://review.openstack.org/581703 Project: openstack/airship-in-a-bottle Branch: refs/heads/master
-rw-r--r--.gitignore1
-rw-r--r--.zuul.yaml49
-rw-r--r--Makefile8
-rw-r--r--tools/gate/playbooks/doc-build.yaml20
-rw-r--r--tools/gate/playbooks/doc-publish.yaml25
-rw-r--r--tox.ini4
6 files changed, 103 insertions, 4 deletions
diff --git a/.gitignore b/.gitignore
index a9ed382..affbedc 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,6 +1,7 @@
1# Sphinx documentation 1# Sphinx documentation
2doc/_build/ 2doc/_build/
3doc/build/ 3doc/build/
4.tox
4 5
5# OSX folder settings files 6# OSX folder settings files
6.DS_Store 7.DS_Store
diff --git a/.zuul.yaml b/.zuul.yaml
index f0a4bec..6fa8018 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -14,11 +14,60 @@
14 check: 14 check:
15 jobs: 15 jobs:
16 - airship-in-a-bottle-linter 16 - airship-in-a-bottle-linter
17 - airship-in-a-bottle-doc-build
17 gate: 18 gate:
18 jobs: 19 jobs:
19 - airship-in-a-bottle-linter 20 - airship-in-a-bottle-linter
21 - airship-in-a-bottle-doc-build
22 post:
23 jobs:
24 - airship-in-a-bottle-doc-publish
20 25
21- job: 26- job:
22 name: airship-in-a-bottle-linter 27 name: airship-in-a-bottle-linter
23 run: tools/gate/playbooks/zuul-linter.yaml 28 run: tools/gate/playbooks/zuul-linter.yaml
24 nodeset: openstack-helm-single-node 29 nodeset: openstack-helm-single-node
30
31- job:
32 name: airship-in-a-bottle-doc-build
33 description: |
34 Locally build the documentation to check for errors
35 run: tools/gate/playbooks/doc-build.yaml
36 timeout: 300
37 nodeset: openstack-helm-single-node
38
39- job:
40 name: airship-in-a-bottle-doc-publish
41 description: |
42 Publish documentation on airship-drydock.readthedocs.io
43 run: tools/gate/playbooks/doc-publish.yaml
44 secrets:
45 - airship_in_a_bottle_readthedocs
46 timeout: 300
47 nodeset: openstack-helm-single-node
48
49- secret:
50 name: airship_in_a_bottle_readthedocs
51 data:
52 url: !encrypted/pkcs1-oaep
53 - Uml3UChtbn2PP4DbTsf4qC2rStfp07DuWe5NN5pS0KIcOenbD0QX7hvx2MgQkChyKTDTs
54 QhiHolVNAoKCcoHjF8WjFXnk7lVb1Ap4K23J/BFO22OvfziMLEcWfsPIr7a7vHQ/svaiy
55 5YYqHCcJYD43CyzsJKUA7Wjfz+JHu9ZpQQGQY53H/UKxMnou3yuFNjLkCp7jQN7ZAIBX2
56 3IrmstRbhZtJTuQ0+Pncr6t3eSPssc6AU+EG4wlBIp+/MxqsIDkEz3AjWiEkMhxUOEIj6
57 nN9Evswpkyg16u4mDnFJ5vRU73e/cR95I4g5TAXbqD8Ek0PDlL1CXWeyJsabBw/UDhdBz
58 8zGa2o/lke3Wn47asEcs5nyP+DX8rIphXTT8YXjnzrL8Lvj9kaRHqvFcIX29x9gr3diev
59 l6CE7hxPtVLU2PsBWCVjxlkX46OockIWoDJJ4Q9tmpilGPlxlDVhJ485bW0dr8EJFdnGV
60 9eJBGFamrZLiH5h6mOiDtqO1MnuXMLHeA7gnxcRlAC51jh5LzjQFh2wQ9K41T3oZXp+sE
61 TR6pfIsQzTdFl2LMLs+UXRULGcDciJDUxySkTF+W3FEIuMBPN2beL0JFQuPdKbbl0pcpn
62 gCZ/ok3a83q6WMrl68Si6ODJeLSyJ8lRc3m6tADgGekcRfaT2C/BjD6yEvsJiM=
63 token: !encrypted/pkcs1-oaep
64 - SZLvIg3x9of5ORJJsH5BSZVPG5xtoTFWvFaPSAp6T0JIdYcbx03RXnZx3ZAftwQwv908X
65 OycWj3QrIIfXa8rmS7pJ3H3cNBXjB5KISiqWu00u5K2ZOiWt30NrKy3gU0cuyi2iBo38u
66 W034X5Z6onswmzIsvGs7DxxGcSq+RF/2hqAspdzGj7carW3QZoQLkmDDHScnRenH8IB4+
67 XMX/4gO63tqyZGczrd18O+4AlLdRFcAR7ScuVnSpr6KnxyBUfvOec83swS1F60wTniFe5
68 4GwUKcqWG9C4HjoJ4D0+xGO1ZnPd03w1T/mBTU79z86p9IL2rFrJcSwxshKPWDTY+JrmT
69 K9Zn1GYaPJk6oDeHNmJz7b66zcbf8glb2D9KAWeNeCfX+oUPZDw+1ePtGTKV1DcWoQFhp
70 L5IHgyrixkT4hO4LvuRAn0ZRWjV/MWh618HzbgB5785GJlnSnBgeDFcy9+AbmhoWh37C3
71 y7tIF6i8j8Jvlsazmj7XfUeNqLB6V7ibMXc1yKMUBhwMKFLYgAOJbMRtS338Uqj4GCSFa
72 78q40byAbR0O6uHiCtZxrEvAUKz3LJcd+jpKfnSDtnLPAs4je7YUNaCYkGPZnSeaY0XuU
73 2Xjb0r3VK7XNIy8hwC5hj/nb8LGU6Q41mKSSVGF41pK8dLEa4X+LJn21PGDbBI=
diff --git a/Makefile b/Makefile
index 984020f..48caf18 100644
--- a/Makefile
+++ b/Makefile
@@ -1,4 +1,4 @@
1# Copyright 2017 AT&T Intellectual Property. All other rights reserved. 1# Copyright 2018 AT&T Intellectual Property. All other rights reserved.
2# 2#
3# Licensed under the Apache License, Version 2.0 (the "License"); 3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License. 4# you may not use this file except in compliance with the License.
@@ -11,7 +11,11 @@
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and 12# See the License for the specific language governing permissions and
13# limitations under the License. 13# limitations under the License.
14SHELL = /bin/bash
14 15
15.PHONY: docs 16.PHONY: docs
16docs: 17docs: build_docs
18
19.PHONY: build_docs
20build_docs:
17 tox -e docs 21 tox -e docs
diff --git a/tools/gate/playbooks/doc-build.yaml b/tools/gate/playbooks/doc-build.yaml
new file mode 100644
index 0000000..b7b2aa1
--- /dev/null
+++ b/tools/gate/playbooks/doc-build.yaml
@@ -0,0 +1,20 @@
1# Licensed under the Apache License, Version 2.0 (the "License");
2# you may not use this file except in compliance with the License.
3# You may obtain a copy of the License at
4#
5# http://www.apache.org/licenses/LICENSE-2.0
6#
7# Unless required by applicable law or agreed to in writing, software
8# distributed under the License is distributed on an "AS IS" BASIS,
9# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10# See the License for the specific language governing permissions and
11# limitations under the License.
12
13- hosts: primary
14 tasks:
15 - name: Build documents locally
16 make:
17 chdir: "{{ zuul.project.src_dir }}"
18 target: docs
19 register: result
20 failed_when: result.failed
diff --git a/tools/gate/playbooks/doc-publish.yaml b/tools/gate/playbooks/doc-publish.yaml
new file mode 100644
index 0000000..b97118e
--- /dev/null
+++ b/tools/gate/playbooks/doc-publish.yaml
@@ -0,0 +1,25 @@
1# Copyright 2018 AT&T Intellectual Property. All other rights reserved.
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7# http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14
15- hosts: primary
16 tasks:
17 - name: Publish current merged documents on readthedocs
18 no_log: true
19 uri:
20 method: POST
21 body_format: 'json'
22 body:
23 token: '{{ airship_in_a_bottle_readthedocs.token | trim }}'
24 url: '{{ airship_in_a_bottle_readthedocs.url | trim }}'
25 follow_redirects: all
diff --git a/tox.ini b/tox.ini
index 41951a3..70d2201 100644
--- a/tox.ini
+++ b/tox.ini
@@ -13,7 +13,7 @@ install_command = pip install {opts} {packages}
13[testenv:docs] 13[testenv:docs]
14basepython = python3 14basepython = python3
15deps = -r{toxinidir}/doc/requirements.txt 15deps = -r{toxinidir}/doc/requirements.txt
16whitelist_externals = rm
16commands = 17commands =
17 rm -rf doc/build 18 rm -rf doc/build
18 sphinx-build -W -b html doc/source doc/build/html 19 sphinx-build -W -b html doc/source doc/build
19whitelist_externals = rm