summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoman Gorshunov <roman.gorshunov@att.com>2018-09-14 15:07:06 +0200
committerFelipe Monteiro <felipe.monteiro@att.com>2018-10-04 16:38:36 +0000
commitc53ab7e423c97102c8efc0190abc0fc6eb3916f1 (patch)
tree6e526a6cff644c8fb86d6c23e5daff3cf40be0cb
parent38634f1aa6c9c6c60d7c94bde7ef743b4b6915af (diff)
Set up publishing of docs
Set up publishing of docs to the readthedocs. Change-Id: Id3ceba960d6b1cf441b13bfc875b17fb0b09de2c
Notes
Notes (review): Code-Review+2: Felipe Monteiro <felipe.monteiro@att.com> Code-Review+1: Drew Walters <drewwalters96@gmail.com> Code-Review+2: Pete Birley <petebirley@gmail.com> Workflow+1: Pete Birley <petebirley@gmail.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Thu, 04 Oct 2018 20:16:24 +0000 Reviewed-on: https://review.openstack.org/581701 Project: openstack/airship-divingbell Branch: refs/heads/master
-rw-r--r--.zuul.yaml5
-rw-r--r--Makefile8
-rw-r--r--README.md3
-rw-r--r--tox.ini11
4 files changed, 18 insertions, 9 deletions
diff --git a/.zuul.yaml b/.zuul.yaml
index 5b45fdb..496c4dd 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -11,6 +11,10 @@
11# limitations under the License. 11# limitations under the License.
12 12
13- project: 13- project:
14 templates:
15 - docs-on-readthedocs
16 vars:
17 rtd_webhook_id: '47940'
14 check: 18 check:
15 jobs: 19 jobs:
16 - airship-divingbell-linter 20 - airship-divingbell-linter
@@ -28,7 +32,6 @@
28 # - ^.*\.rst$ 32 # - ^.*\.rst$
29 # - ^doc/.*$ 33 # - ^doc/.*$
30 # - ^releasenotes/.*$ 34 # - ^releasenotes/.*$
31
32- job: 35- job:
33 name: airship-divingbell-linter 36 name: airship-divingbell-linter
34 run: tools/gate/playbooks/zuul-linter.yaml 37 run: tools/gate/playbooks/zuul-linter.yaml
diff --git a/Makefile b/Makefile
index 3a06e0d..98932eb 100644
--- a/Makefile
+++ b/Makefile
@@ -43,6 +43,7 @@ clean:
43 rm -rf helm-toolkit/secrets/*.b64 43 rm -rf helm-toolkit/secrets/*.b64
44 rm -rf */templates/_partials.tpl 44 rm -rf */templates/_partials.tpl
45 rm -rf */templates/_globals.tpl 45 rm -rf */templates/_globals.tpl
46 rm -rf doc/build
46 47
47.PHONY: $(EXCLUDES) $(CHARTS) 48.PHONY: $(EXCLUDES) $(CHARTS)
48 49
@@ -54,3 +55,10 @@ charts: clean build-$(CHART)
54# being investigated on how to bring it up to date. 55# being investigated on how to bring it up to date.
55.PHONY: tests 56.PHONY: tests
56tests: charts 57tests: charts
58
59.PHONY: docs
60docs: clean build_docs
61
62.PHONY: build_docs
63build_docs:
64 tox -e docs
diff --git a/README.md b/README.md
index 2469a78..1bd12df 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,4 @@
1# Divingbell 1# Divingbell
2 2
3Documentation can be found [here](https://airship-divingbell.readthedocs.io). 3Find more documentation for Divingbell on
4`Read the Docs <https://airship-divingbell.readthedocs.io/>`_.
diff --git a/tox.ini b/tox.ini
index d9e1768..d3b3e47 100644
--- a/tox.ini
+++ b/tox.ini
@@ -5,6 +5,7 @@ envlist = docs
5 5
6[testenv] 6[testenv]
7usedevelop = True 7usedevelop = True
8whitelist_externals = rm
8passenv = http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY PBR_VERSION 9passenv = http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY PBR_VERSION
9setenv = VIRTUAL_ENV={envdir} 10setenv = VIRTUAL_ENV={envdir}
10install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages} 11install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages}
@@ -15,12 +16,8 @@ commands =
15commands = {posargs} 16commands = {posargs}
16 17
17[testenv:docs] 18[testenv:docs]
19basepython = python3
18deps = -r{toxinidir}/doc/requirements.txt 20deps = -r{toxinidir}/doc/requirements.txt
19commands = 21commands =
20 rm -rf doc/build 22 rm -rf doc/build
21 sphinx-build -W -b html doc/source doc/build/html 23 sphinx-build -W -b html doc/source doc/build/html
22whitelist_externals =
23 rm
24
25[testenv:venv]
26commands = {posargs}