summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZuul <zuul@review.openstack.org>2018-09-27 18:39:30 +0000
committerGerrit Code Review <review@openstack.org>2018-09-27 18:39:30 +0000
commit358f047c332512eb8aa2bd261ae1afc485c431ec (patch)
treef070f4d8660dec0d969c4a8c61b3b1fad3650e9d
parentda7ab1cce34936290a4a70f42e288e4ac7836e5f (diff)
parent20c81644e1ff01a4b59a24db4d58c6afba3080a9 (diff)
Merge "Unify publishing of docs"
-rw-r--r--.zuul.yaml77
-rw-r--r--Makefile31
-rw-r--r--README.rst6
-rw-r--r--gate/playbooks/doc-build.yaml23
-rw-r--r--gate/playbooks/doc-publish.yaml23
-rw-r--r--tox.ini2
6 files changed, 40 insertions, 122 deletions
diff --git a/.zuul.yaml b/.zuul.yaml
index 73be022..d6c266a 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -1,62 +1,17 @@
1- project: 1# Licensed under the Apache License, Version 2.0 (the "License");
2 check: 2# you may not use this file except in compliance with the License.
3 jobs: 3# You may obtain a copy of the License at
4 - airship-specs-doc-build 4#
5 5# http://www.apache.org/licenses/LICENSE-2.0
6 gate: 6#
7 jobs: 7# Unless required by applicable law or agreed to in writing, software
8 - airship-specs-doc-build 8# distributed under the License is distributed on an "AS IS" BASIS,
9 9# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10 post: 10# See the License for the specific language governing permissions and
11 jobs: 11# limitations under the License.
12 - airship-specs-doc-publish
13
14- nodeset:
15 name: airship-specs-single-node
16 nodes:
17 - name: primary
18 label: ubuntu-xenial
19 12
20- job: 13- project:
21 name: airship-specs-doc-build 14 templates:
22 description: | 15 - docs-on-readthedocs
23 Build documents locally to validate functionality 16 vars:
24 run: gate/playbooks/doc-build.yaml 17 rtd_webhook_id: '43959'
25 timeout: 900
26 nodeset: airship-specs-single-node
27
28- job:
29 name: airship-specs-doc-publish
30 description: |
31 Publish documentation on airship-specs.readthedocs.io
32 run: gate/playbooks/doc-publish.yaml
33 secrets:
34 - airship_specs_readthedocs
35 timeout: 300
36 nodeset: airship-specs-single-node
37
38- secret:
39 name: airship_specs_readthedocs
40 data:
41 url: !encrypted/pkcs1-oaep
42 - THj6TIhcV42OhTsG1mA59bUbeKNd/64KCt2Bnqh8D+Fjr2VbaojqHT51/UhuRf+y4BKDi
43 Hlaf0kNUS0X4VB5QanDh/mKlU/GhMIyUBCD1PlzMxiefcVl04F+Z0GKlPXJ+qzKYRYK6F
44 2i4m8PeCGa8otqUiiqznY0US5Rb0++dEZ6ipuFuaLDl7mmV4MqWuPVJdpBuYqsH/OP6Hd
45 VPvSw68Arbqo7n/hriCoI5ZVx9Xk8xhfSTCkUDjhEaHEr+ECTPZLxqmArPEi+gGwEqiLa
46 LWwftEeDc2OaSL0X8XlAcCGFYJeLRp5uCTIOh2T0HuIgZxPJ1aHyvvyd3ieyw+ndx27og
47 DYPf3/svoYWBaDkQpFQpYFWIwMnzKiZp5giOb2XIr3co43gu/nT49UZJSkc2MPtWMArRb
48 CHkj7/MF+lHEDlCEGC+x0u+B1t1Qn++JWVXMDEhHm+KUJ83Q0QSUC1ImJgKgDHWeGAMK/
49 6OABOer4D6qG88PHaoSmiKrX7o9tjiuPkVfZYrKjgQSXRj8Iv1GSHdQCjcit/HNFx75Lu
50 yPmkFA5XzGXAHNpt33ktib5/ZVzYdFV7lFoNDxs2cDb+qJvD1zAL8rDgwOk7cjv1qWHR+
51 1VgnGBiWamD0SRCMY0beTjWQpouius5mfI+d+LPlNr8i1okic6sd2vhG93HMpw=
52 token: !encrypted/pkcs1-oaep
53 - ZYf6430ZTYgnN3HnbFMUqb0Q8iQWmhpns1UutcWuhOjDYBT7NBvmjJRoAzKTL4JI9qpbm
54 EIL2BwpmSGRmJauzJKaTxTitRTGkLZB9nBsBjKw3tu/ga1Mz18IWfKoJWFfhs+omd/YgZ
55 DX1nf8I+2Dmmee+lbGfkd8Km39hXRVEkDdT/9fRH7w0JJullf/LHJlQs+mQuGxj4S6lQ0
56 GINVneKZKj7EOsoOQexGLDnOjrLDyfUHJiPRTZsg4VTDng/yRb9jJfbph5aTX1QRA2ldp
57 VsO4PZhYOiR30SYcNbUELhA/ZKXYeUWrG4hsI8oeO4dCU5cLPMFkh8i+6fvHRjPvPohOl
58 fj5xNHbz/wHOHlFFLYX2fs2WCRKdX7g8m/nxiN5ofttNq+k99Is5r30iMUXGzoIG8viSb
59 dOcHRXRrFnIa5ZUD4g3QgGnayxXxK9tJqCrW1N9MwfFOIb1kgRCvrGDaho9cOcFshQPTP
60 UfsGHncnV87elimGN/tYf8oAU5FWIzzh8xF/kT1e8mVxGrF4BfBV2/Iy26M0MlbeFqMXY
61 oWgYCTt57yMhrhdqqRrrYsa/5C5rTv6J+cpPv+VtRo6AQm6KLwBl5sLNuCiBZigKDdwwn
62 F/MZZpDi9gkGouoDm6lR+Kje5zpWvdUwJC2TfLst1qFk23FqshAGuOBI9tTRws=
diff --git a/Makefile b/Makefile
index 1e77038..908367f 100644
--- a/Makefile
+++ b/Makefile
@@ -1,15 +1,24 @@
1# Minimal makefile for Sphinx documentation 1# Copyright 2018 AT&T Intellectual Property. All other rights reserved.
2# 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.
3 14
4# You can set these variables from the command line. 15.PHONY: docs
5# TODO: Incorporate these vars into tox file 16docs: clean build_docs
6SPHINXOPTS = -a -E -W
7SPHINXBUILD = sphinx-build
8SPHINXPROJ = airship-specs
9SOURCEDIR = doc/source
10BUILDDIR = doc/build
11 17
12docs: 18.PHONY: clean
13 tox 19clean:
20 rm -rf doc/build
14 21
15%: docs 22.PHONY: build_docs
23build_docs:
24 tox -e docs
diff --git a/README.rst b/README.rst
index d3132a5..4dc297c 100644
--- a/README.rst
+++ b/README.rst
@@ -10,9 +10,9 @@
10Building Airship Specs Documentation 10Building Airship Specs Documentation
11==================================== 11====================================
12 12
13Using the equivalent of `pip install sphinx`, install the sphinx-build command 13Find more documentation for Airship Specs on
14if it is not already installed. 14`Read the Docs <https://airship-specs.readthedocs.io/>`_.
15 15
16From the root of this project, issue the command `make html`. 16From the root of this project, issue the command `make docs`.
17Sphinx will render the output into doc/build/html. Open 17Sphinx will render the output into doc/build/html. Open
18doc/build/html/index.html using your browser. 18doc/build/html/index.html using your browser.
diff --git a/gate/playbooks/doc-build.yaml b/gate/playbooks/doc-build.yaml
deleted file mode 100644
index b7e4459..0000000
--- a/gate/playbooks/doc-build.yaml
+++ /dev/null
@@ -1,23 +0,0 @@
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# Combine several test tasks into a single playbook
14# to minimize Zuul node consumption
15
16- hosts: primary
17 tasks:
18 - name: Build documents locally
19 make:
20 chdir: "{{ zuul.project.src_dir }}"
21 target: docs
22 register: result
23
diff --git a/gate/playbooks/doc-publish.yaml b/gate/playbooks/doc-publish.yaml
deleted file mode 100644
index ee6dac7..0000000
--- a/gate/playbooks/doc-publish.yaml
+++ /dev/null
@@ -1,23 +0,0 @@
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: Publish current merged documents on readthedocs
16 no_log: true
17 uri:
18 method: 'POST'
19 body_format: 'json'
20 url: '{{ airship_specs_readthedocs.url | trim}}'
21 body:
22 token: '{{ airship_specs_readthedocs.token | trim }}'
23 register: result
diff --git a/tox.ini b/tox.ini
index 6d4496d..eb1b744 100644
--- a/tox.ini
+++ b/tox.ini
@@ -15,4 +15,4 @@ whitelist_externals=
15 rm 15 rm
16commands= 16commands=
17 rm -rf doc/build 17 rm -rf doc/build
18 sphinx-build -b html doc/source doc/build -a -E -W 18 sphinx-build -W -b html doc/source doc/build/html