Browse Source

Set up publishing of docs

Set up publishing of docs to the readthedocs.

Change-Id: Idfafa228e9136de3cec72d9df82b537ebd8fc8d3
changes/11/581711/5
Roman Gorshunov 2 years ago
parent
commit
785c4ca5f5
19 changed files with 17 additions and 11 deletions
  1. +4
    -1
      .zuul.yaml
  2. +5
    -5
      Makefile
  3. +3
    -0
      README.rst
  4. +0
    -0
      doc/requirements.txt
  5. +0
    -0
      doc/source/API.rst
  6. +0
    -0
      doc/source/CLI.rst
  7. +0
    -0
      doc/source/_static/.placeholder
  8. +0
    -0
      doc/source/_static/shipyard.conf.sample
  9. +0
    -0
      doc/source/_static/shipyard.policy.yaml.sample
  10. +0
    -0
      doc/source/action-commands.rst
  11. +0
    -0
      doc/source/client-user-guide.rst
  12. +0
    -0
      doc/source/conf.py
  13. +0
    -0
      doc/source/deployment-guide.rst
  14. +0
    -0
      doc/source/docutils.conf
  15. +0
    -0
      doc/source/index.rst
  16. +0
    -0
      doc/source/policy-enforcement.rst
  17. +0
    -0
      doc/source/sampleconf.rst
  18. +0
    -0
      doc/source/site-definition-documents.rst
  19. +5
    -5
      tox.ini

+ 4
- 1
.zuul.yaml View File

@ -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


+ 5
- 5
Makefile View File

@ -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

+ 3
- 0
README.rst View File

@ -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


docs/requirements.txt → doc/requirements.txt View File


docs/source/API.rst → doc/source/API.rst View File


docs/source/CLI.rst → doc/source/CLI.rst View File


docs/source/_static/.placeholder → doc/source/_static/.placeholder View File


docs/source/_static/shipyard.conf.sample → doc/source/_static/shipyard.conf.sample View File


docs/source/_static/shipyard.policy.yaml.sample → doc/source/_static/shipyard.policy.yaml.sample View File


docs/source/action-commands.rst → doc/source/action-commands.rst View File


docs/source/client-user-guide.rst → doc/source/client-user-guide.rst View File


docs/source/conf.py → doc/source/conf.py View File


docs/source/deployment-guide.rst → doc/source/deployment-guide.rst View File


docs/source/docutils.conf → doc/source/docutils.conf View File


docs/source/index.rst → doc/source/index.rst View File


docs/source/policy-enforcement.rst → doc/source/policy-enforcement.rst View File


docs/source/sampleconf.rst → doc/source/sampleconf.rst View File


docs/source/site-definition-documents.rst → doc/source/site-definition-documents.rst View File


+ 5
- 5
tox.ini View File

@ -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.


Loading…
Cancel
Save