From 785c4ca5f5b237171cd268417e269e59d2691b98 Mon Sep 17 00:00:00 2001 From: Roman Gorshunov Date: Fri, 14 Sep 2018 15:07:07 +0200 Subject: [PATCH] Set up publishing of docs Set up publishing of docs to the readthedocs. Change-Id: Idfafa228e9136de3cec72d9df82b537ebd8fc8d3 --- .zuul.yaml | 5 ++++- Makefile | 10 +++++----- README.rst | 3 +++ {docs => doc}/requirements.txt | 0 {docs => doc}/source/API.rst | 0 {docs => doc}/source/CLI.rst | 0 {docs => doc}/source/_static/.placeholder | 0 {docs => doc}/source/_static/shipyard.conf.sample | 0 .../source/_static/shipyard.policy.yaml.sample | 0 {docs => doc}/source/action-commands.rst | 0 {docs => doc}/source/client-user-guide.rst | 0 {docs => doc}/source/conf.py | 0 {docs => doc}/source/deployment-guide.rst | 0 {docs => doc}/source/docutils.conf | 0 {docs => doc}/source/index.rst | 0 {docs => doc}/source/policy-enforcement.rst | 0 {docs => doc}/source/sampleconf.rst | 0 {docs => doc}/source/site-definition-documents.rst | 0 tox.ini | 10 +++++----- 19 files changed, 17 insertions(+), 11 deletions(-) rename {docs => doc}/requirements.txt (100%) rename {docs => doc}/source/API.rst (100%) rename {docs => doc}/source/CLI.rst (100%) rename {docs => doc}/source/_static/.placeholder (100%) rename {docs => doc}/source/_static/shipyard.conf.sample (100%) rename {docs => doc}/source/_static/shipyard.policy.yaml.sample (100%) rename {docs => doc}/source/action-commands.rst (100%) rename {docs => doc}/source/client-user-guide.rst (100%) rename {docs => doc}/source/conf.py (100%) rename {docs => doc}/source/deployment-guide.rst (100%) rename {docs => doc}/source/docutils.conf (100%) rename {docs => doc}/source/index.rst (100%) rename {docs => doc}/source/policy-enforcement.rst (100%) rename {docs => doc}/source/sampleconf.rst (100%) rename {docs => doc}/source/site-definition-documents.rst (100%) diff --git a/.zuul.yaml b/.zuul.yaml index 3906ecde..5c8b522b 100644 --- a/.zuul.yaml +++ b/.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 diff --git a/Makefile b/Makefile index 57335940..394ecc1e 100644 --- a/Makefile +++ b/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 \ No newline at end of file diff --git a/README.rst b/README.rst index 4f08d5f4..3eb53963 100644 --- a/README.rst +++ b/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 `_. + The current workflow is as follows: 1. Initial region/site data will be passed to Shipyard from either a human diff --git a/docs/requirements.txt b/doc/requirements.txt similarity index 100% rename from docs/requirements.txt rename to doc/requirements.txt diff --git a/docs/source/API.rst b/doc/source/API.rst similarity index 100% rename from docs/source/API.rst rename to doc/source/API.rst diff --git a/docs/source/CLI.rst b/doc/source/CLI.rst similarity index 100% rename from docs/source/CLI.rst rename to doc/source/CLI.rst diff --git a/docs/source/_static/.placeholder b/doc/source/_static/.placeholder similarity index 100% rename from docs/source/_static/.placeholder rename to doc/source/_static/.placeholder diff --git a/docs/source/_static/shipyard.conf.sample b/doc/source/_static/shipyard.conf.sample similarity index 100% rename from docs/source/_static/shipyard.conf.sample rename to doc/source/_static/shipyard.conf.sample diff --git a/docs/source/_static/shipyard.policy.yaml.sample b/doc/source/_static/shipyard.policy.yaml.sample similarity index 100% rename from docs/source/_static/shipyard.policy.yaml.sample rename to doc/source/_static/shipyard.policy.yaml.sample diff --git a/docs/source/action-commands.rst b/doc/source/action-commands.rst similarity index 100% rename from docs/source/action-commands.rst rename to doc/source/action-commands.rst diff --git a/docs/source/client-user-guide.rst b/doc/source/client-user-guide.rst similarity index 100% rename from docs/source/client-user-guide.rst rename to doc/source/client-user-guide.rst diff --git a/docs/source/conf.py b/doc/source/conf.py similarity index 100% rename from docs/source/conf.py rename to doc/source/conf.py diff --git a/docs/source/deployment-guide.rst b/doc/source/deployment-guide.rst similarity index 100% rename from docs/source/deployment-guide.rst rename to doc/source/deployment-guide.rst diff --git a/docs/source/docutils.conf b/doc/source/docutils.conf similarity index 100% rename from docs/source/docutils.conf rename to doc/source/docutils.conf diff --git a/docs/source/index.rst b/doc/source/index.rst similarity index 100% rename from docs/source/index.rst rename to doc/source/index.rst diff --git a/docs/source/policy-enforcement.rst b/doc/source/policy-enforcement.rst similarity index 100% rename from docs/source/policy-enforcement.rst rename to doc/source/policy-enforcement.rst diff --git a/docs/source/sampleconf.rst b/doc/source/sampleconf.rst similarity index 100% rename from docs/source/sampleconf.rst rename to doc/source/sampleconf.rst diff --git a/docs/source/site-definition-documents.rst b/doc/source/site-definition-documents.rst similarity index 100% rename from docs/source/site-definition-documents.rst rename to doc/source/site-definition-documents.rst diff --git a/tox.ini b/tox.ini index 20537801..8774b4a3 100644 --- a/tox.ini +++ b/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/shipyard.conf.sample {toxinidir}/docs/source/_static/shipyard.conf.sample - rm -rf {toxinidir}/docs/build - sphinx-build -b html {toxinidir}/docs/source {toxinidir}/docs/build -deps= -r{toxinidir}/docs/requirements.txt + 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}/doc/source/_static/shipyard.conf.sample + rm -rf {toxinidir}/doc/build + sphinx-build -W -b html {toxinidir}/doc/source {toxinidir}/doc/build/html +deps= -r{toxinidir}/doc/requirements.txt # `all_jobs` is here to support invocation as simply `tox`, as is done in # current pipeline.