Set up publishing of docs

Set up publishing of docs to the readthedocs.

Change-Id: Idfafa228e9136de3cec72d9df82b537ebd8fc8d3

.zuul.yaml

@@ -11,6 +11,10 @@
 # limitations under the License.
 
 - project:
+    templates:
+      - docs-on-readthedocs
+    vars:
+      rtd_webhook_id: '38576'
     check:
       jobs:
         - openstack-tox-pep8
@@ -172,7 +176,6 @@
           BXeHSJY2wGADZChYKVl1/DFn2w5R8sjf+JMUhDkfNUXFFfLS12lWexNH7V2PAy3mQrnQ0
           +IYNI959TAdyUwa9ZyQyu0lTkQpsuUwBSfnJ9+1orwlruzGeCeofIfHIzWitmB5yxtI/Z
           XRw2Uif34GEkerIQGnoQazOTVf6jAw/gp9X49+WpghTC+ExKTqCelggcKBukZA=
-
       password: !encrypted/pkcs1-oaep
         - ts6uhbQxb9EKWfQ1RmZUZGKoGEkJ9RkyupmmFHZllo2iEqNG21jrqhBbHVEt9iXqOGAUL
           AICzGos4p/RQXgISmmGVmBfR2MhH93txPLtKfIQCMw/838Mmy4z1gr1ALhepnEsgb3d9X

Makefile

@@ -64,9 +64,6 @@ lint: pep8 helm_lint build_docs
 dry-run: clean helm-init
 	$(HELM) template charts/shipyard
 
-.PHONY: docs
-docs: clean build_docs
-
 .PHONY: security
 security:
 	cd $(BUILD_CTX)/shipyard_client; tox -e bandit
@@ -128,7 +125,7 @@ endif
 .PHONY: clean
 clean:
 	rm -rf build
-	rm -rf docs/build
+	rm -rf doc/build
 	cd $(BUILD_CTX)/shipyard_client; rm -rf build
 	cd $(BUILD_CTX)/shipyard_airflow; rm -rf build
 
@@ -151,6 +148,9 @@ helm-init: helm-install
 helm-install:
 	tools/helm_install.sh $(HELM)
 
+.PHONY: docs
+docs: clean build_docs
+
 .PHONY: build_docs
 build_docs:
-	tox -e docs
+	tox -e docs

README.rst

@@ -5,6 +5,9 @@ Shipyard
 Shipyard adopts the Falcon web framework and uses Apache Airflow as the backend
 engine to programmatically author, schedule and monitor workflows.
 
+Find more documentation for Shipyard on
+`Read the Docs <https://airship-shipyard.readthedocs.io/>`_.
+
 The current workflow is as follows:
 
 1. Initial region/site data will be passed to Shipyard from either a human

tox.ini

@@ -19,11 +19,11 @@ whitelist_externals=
     tox
 commands=
     tox -c {toxinidir}/src/bin/shipyard_airflow/tox.ini -e gen_all
-    cp {toxinidir}/src/bin/shipyard_airflow/etc/shipyard/policy.yaml.sample {toxinidir}/docs/source/_static/shipyard.policy.yaml.sample
+    cp {toxinidir}/src/bin/shipyard_airflow/etc/shipyard/policy.yaml.sample {toxinidir}/doc/source/_static/shipyard.policy.yaml.sample
-    cp {toxinidir}/src/bin/shipyard_airflow/etc/shipyard/shipyard.conf.sample {toxinidir}/docs/source/_static/shipyard.conf.sample
+    cp {toxinidir}/src/bin/shipyard_airflow/etc/shipyard/shipyard.conf.sample {toxinidir}/doc/source/_static/shipyard.conf.sample
-    rm -rf {toxinidir}/docs/build
+    rm -rf {toxinidir}/doc/build
-    sphinx-build -b html {toxinidir}/docs/source {toxinidir}/docs/build
+    sphinx-build -W -b html {toxinidir}/doc/source {toxinidir}/doc/build/html
-deps= -r{toxinidir}/docs/requirements.txt
+deps= -r{toxinidir}/doc/requirements.txt
 
 # `all_jobs` is here to support invocation as simply `tox`, as is done in
 # current pipeline.