Browse Source

Merge "Set up publishing of docs"

Zuul 6 months ago
parent
commit
623779b66c
4 changed files with 18 additions and 9 deletions
  1. 4
    1
      .zuul.yaml
  2. 8
    0
      Makefile
  3. 2
    1
      README.md
  4. 4
    7
      tox.ini

+ 4
- 1
.zuul.yaml View File

@@ -11,6 +11,10 @@
11 11
 # limitations under the License.
12 12
 
13 13
 - project:
14
+    templates:
15
+      - docs-on-readthedocs
16
+    vars:
17
+      rtd_webhook_id: '47940'
14 18
     check:
15 19
       jobs:
16 20
         - airship-divingbell-linter
@@ -28,7 +32,6 @@
28 32
         #       - ^.*\.rst$
29 33
         #       - ^doc/.*$
30 34
         #       - ^releasenotes/.*$
31
-
32 35
 - job:
33 36
     name: airship-divingbell-linter
34 37
     run: tools/gate/playbooks/zuul-linter.yaml

+ 8
- 0
Makefile View File

@@ -43,6 +43,7 @@ clean:
43 43
 	rm -rf helm-toolkit/secrets/*.b64
44 44
 	rm -rf */templates/_partials.tpl
45 45
 	rm -rf */templates/_globals.tpl
46
+	rm -rf doc/build
46 47
 
47 48
 .PHONY: $(EXCLUDES) $(CHARTS)
48 49
 
@@ -54,3 +55,10 @@ charts: clean build-$(CHART)
54 55
 #      being investigated on how to bring it up to date.
55 56
 .PHONY: tests
56 57
 tests: charts
58
+
59
+.PHONY: docs
60
+docs: clean build_docs
61
+
62
+.PHONY: build_docs
63
+build_docs:
64
+	tox -e docs

+ 2
- 1
README.md View File

@@ -1,3 +1,4 @@
1 1
 # Divingbell
2 2
 
3
-Documentation can be found [here](https://airship-divingbell.readthedocs.io).
3
+Find more documentation for Divingbell on
4
+`Read the Docs <https://airship-divingbell.readthedocs.io/>`_.

+ 4
- 7
tox.ini View File

@@ -5,6 +5,7 @@ envlist = docs
5 5
 
6 6
 [testenv]
7 7
 usedevelop = True
8
+whitelist_externals = rm
8 9
 passenv = http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY PBR_VERSION
9 10
 setenv = VIRTUAL_ENV={envdir}
10 11
 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 =
15 16
 commands = {posargs}
16 17
 
17 18
 [testenv:docs]
19
+basepython = python3
18 20
 deps = -r{toxinidir}/doc/requirements.txt
19 21
 commands =
20
-  rm -rf doc/build
21
-  sphinx-build -W -b html doc/source doc/build/html
22
-whitelist_externals =
23
-  rm
24
-
25
-[testenv:venv]
26
-commands = {posargs}
22
+    rm -rf doc/build
23
+    sphinx-build -W -b html doc/source doc/build/html

Loading…
Cancel
Save