From c53ab7e423c97102c8efc0190abc0fc6eb3916f1 Mon Sep 17 00:00:00 2001
From: Roman Gorshunov <roman.gorshunov@att.com>
Date: Fri, 14 Sep 2018 15:07:06 +0200
Subject: [PATCH] Set up publishing of docs

Set up publishing of docs to the readthedocs.

Change-Id: Id3ceba960d6b1cf441b13bfc875b17fb0b09de2c
---
 .zuul.yaml |  5 ++++-
 Makefile   |  8 ++++++++
 README.md  |  3 ++-
 tox.ini    | 11 ++++-------
 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 @@
 # limitations under the License.
 
 - project:
+    templates:
+      - docs-on-readthedocs
+    vars:
+      rtd_webhook_id: '47940'
     check:
       jobs:
         - airship-divingbell-linter
@@ -28,7 +32,6 @@
         #       - ^.*\.rst$
         #       - ^doc/.*$
         #       - ^releasenotes/.*$
-
 - job:
     name: airship-divingbell-linter
     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:
 	rm -rf helm-toolkit/secrets/*.b64
 	rm -rf */templates/_partials.tpl
 	rm -rf */templates/_globals.tpl
+	rm -rf doc/build
 
 .PHONY: $(EXCLUDES) $(CHARTS)
 
@@ -54,3 +55,10 @@ charts: clean build-$(CHART)
 #      being investigated on how to bring it up to date.
 .PHONY: tests
 tests: charts
+
+.PHONY: docs
+docs: clean build_docs
+
+.PHONY: build_docs
+build_docs:
+	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 @@
 # Divingbell
 
-Documentation can be found [here](https://airship-divingbell.readthedocs.io).
+Find more documentation for Divingbell on
+`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
 
 [testenv]
 usedevelop = True
+whitelist_externals = rm
 passenv = http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY PBR_VERSION
 setenv = VIRTUAL_ENV={envdir}
 install_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 =
 commands = {posargs}
 
 [testenv:docs]
+basepython = python3
 deps = -r{toxinidir}/doc/requirements.txt
 commands =
-  rm -rf doc/build
-  sphinx-build -W -b html doc/source doc/build/html
-whitelist_externals =
-  rm
-
-[testenv:venv]
-commands = {posargs}
+    rm -rf doc/build
+    sphinx-build -W -b html doc/source doc/build/html