Merge "Set up publishing of docs"
This commit is contained in:
commit
623779b66c
|
@ -11,6 +11,10 @@
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
|
|
||||||
- project:
|
- project:
|
||||||
|
templates:
|
||||||
|
- docs-on-readthedocs
|
||||||
|
vars:
|
||||||
|
rtd_webhook_id: '47940'
|
||||||
check:
|
check:
|
||||||
jobs:
|
jobs:
|
||||||
- airship-divingbell-linter
|
- airship-divingbell-linter
|
||||||
|
@ -28,7 +32,6 @@
|
||||||
# - ^.*\.rst$
|
# - ^.*\.rst$
|
||||||
# - ^doc/.*$
|
# - ^doc/.*$
|
||||||
# - ^releasenotes/.*$
|
# - ^releasenotes/.*$
|
||||||
|
|
||||||
- job:
|
- job:
|
||||||
name: airship-divingbell-linter
|
name: airship-divingbell-linter
|
||||||
run: tools/gate/playbooks/zuul-linter.yaml
|
run: tools/gate/playbooks/zuul-linter.yaml
|
||||||
|
|
8
Makefile
8
Makefile
|
@ -43,6 +43,7 @@ clean:
|
||||||
rm -rf helm-toolkit/secrets/*.b64
|
rm -rf helm-toolkit/secrets/*.b64
|
||||||
rm -rf */templates/_partials.tpl
|
rm -rf */templates/_partials.tpl
|
||||||
rm -rf */templates/_globals.tpl
|
rm -rf */templates/_globals.tpl
|
||||||
|
rm -rf doc/build
|
||||||
|
|
||||||
.PHONY: $(EXCLUDES) $(CHARTS)
|
.PHONY: $(EXCLUDES) $(CHARTS)
|
||||||
|
|
||||||
|
@ -54,3 +55,10 @@ charts: clean build-$(CHART)
|
||||||
# being investigated on how to bring it up to date.
|
# being investigated on how to bring it up to date.
|
||||||
.PHONY: tests
|
.PHONY: tests
|
||||||
tests: charts
|
tests: charts
|
||||||
|
|
||||||
|
.PHONY: docs
|
||||||
|
docs: clean build_docs
|
||||||
|
|
||||||
|
.PHONY: build_docs
|
||||||
|
build_docs:
|
||||||
|
tox -e docs
|
||||||
|
|
|
@ -1,3 +1,4 @@
|
||||||
# Divingbell
|
# 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/>`_.
|
||||||
|
|
11
tox.ini
11
tox.ini
|
@ -5,6 +5,7 @@ envlist = docs
|
||||||
|
|
||||||
[testenv]
|
[testenv]
|
||||||
usedevelop = True
|
usedevelop = True
|
||||||
|
whitelist_externals = rm
|
||||||
passenv = http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY PBR_VERSION
|
passenv = http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY PBR_VERSION
|
||||||
setenv = VIRTUAL_ENV={envdir}
|
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}
|
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}
|
commands = {posargs}
|
||||||
|
|
||||||
[testenv:docs]
|
[testenv:docs]
|
||||||
|
basepython = python3
|
||||||
deps = -r{toxinidir}/doc/requirements.txt
|
deps = -r{toxinidir}/doc/requirements.txt
|
||||||
commands =
|
commands =
|
||||||
rm -rf doc/build
|
rm -rf doc/build
|
||||||
sphinx-build -W -b html doc/source doc/build/html
|
sphinx-build -W -b html doc/source doc/build/html
|
||||||
whitelist_externals =
|
|
||||||
rm
|
|
||||||
|
|
||||||
[testenv:venv]
|
|
||||||
commands = {posargs}
|
|
||||||
|
|
Loading…
Reference in New Issue