Browse Source

Set up publishing of docs

Set up publishing of docs to the readthedocs.

Change-Id: If42d4fa5937ab8edd0bacb20534328db8f1df216
Roman Gorshunov 7 months ago
parent
commit
67372bade2
11 changed files with 41 additions and 4 deletions
  1. 1
    1
      .gitignore
  2. 17
    0
      .zuul.yaml
  3. 8
    0
      Makefile
  4. 3
    0
      README.md
  5. 7
    0
      doc/requirements.txt
  6. 0
    0
      doc/source/_static/.placeholder
  7. 0
    0
      doc/source/conf.py
  8. 0
    0
      doc/source/index.rst
  9. 0
    0
      doc/source/readme.rst
  10. 2
    2
      setup.cfg
  11. 3
    1
      tox.ini

+ 1
- 1
.gitignore View File

@@ -68,7 +68,7 @@ instance/
68 68
 .scrapy
69 69
 
70 70
 # Sphinx documentation
71
-docs/_build/
71
+doc/_build/
72 72
 
73 73
 # PyBuilder
74 74
 target/

+ 17
- 0
.zuul.yaml View File

@@ -0,0 +1,17 @@
1
+# Licensed under the Apache License, Version 2.0 (the "License");
2
+# you may not use this file except in compliance with the License.
3
+# You may obtain a copy of the License at
4
+#
5
+#     http://www.apache.org/licenses/LICENSE-2.0
6
+#
7
+# Unless required by applicable law or agreed to in writing, software
8
+# distributed under the License is distributed on an "AS IS" BASIS,
9
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10
+# See the License for the specific language governing permissions and
11
+# limitations under the License.
12
+
13
+- project:
14
+    templates:
15
+      - docs-on-readthedocs
16
+    vars:
17
+      rtd_webhook_id: '47941'

+ 8
- 0
Makefile View File

@@ -34,6 +34,14 @@ build:
34 34
 
35 35
 clean:
36 36
 	rm -f *~ */*~ */*/*~ berth-0.1.0.tgz
37
+	rm -rf doc/build
38
+
39
+.PHONY: docs
40
+docs: clean build_docs
41
+
42
+.PHONY: build_docs
43
+build_docs:
44
+	tox -e docs
37 45
 
38 46
 .PHONY:
39 47
 	all default build clean test-validate test-install test-uninstall

+ 3
- 0
README.md View File

@@ -1,5 +1,8 @@
1 1
 Berth is a deliberately minimalist VM runner for Kubernetes.
2 2
 
3
+Find more documentation for Berth on
4
+`Read the Docs <https://airship-berth.readthedocs.io/>`_.
5
+
3 6
 ## TL;DR Installation Guide
4 7
 
5 8
 Install the bare Berth chart:

+ 7
- 0
doc/requirements.txt View File

@@ -0,0 +1,7 @@
1
+# The order of packages is significant, because pip processes them in the order
2
+# of appearance. Changing the order has an impact on the overall integration
3
+# process, which may cause wedges in the gate later.
4
+sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
5
+sphinxcontrib-apidoc>=0.2.0  # BSD
6
+sphinx_rtd_theme>=0.2.4
7
+reno>=2.5.0 # Apache-2.0

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


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


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


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


+ 2
- 2
setup.cfg View File

@@ -21,8 +21,8 @@ packages =
21 21
     berth
22 22
 
23 23
 [build_sphinx]
24
-source-dir = docs/source
25
-build-dir = docs/build
24
+source-dir = doc/source
25
+build-dir = doc/build
26 26
 all_files = 1
27 27
 warning-is-error = 1
28 28
 

+ 3
- 1
tox.ini View File

@@ -18,6 +18,8 @@ commands =
18 18
 commands = {posargs}
19 19
 
20 20
 [testenv:docs]
21
+basepython = python3
22
+deps = -r{toxinidir}/doc/requirements.txt
21 23
 commands =
22 24
     rm -rf doc/build
23
-    python setup.py build_sphinx {posargs}
25
+    sphinx-build -W -b html doc/source doc/build/html

Loading…
Cancel
Save