summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoman Gorshunov <roman.gorshunov@att.com>2018-09-14 15:07:06 +0200
committerRoman Gorshunov <roman.gorshunov@att.com>2018-09-28 19:22:40 +0200
commit67372bade2c1cfbe552900595629b8f381408b2a (patch)
tree6411dab1f69affaa50b42108140913d0b47ece4c
parent7b6bf409d888264c3ac9fd7f105c5540f10dce6f (diff)
Set up publishing of docs
Set up publishing of docs to the readthedocs. Change-Id: If42d4fa5937ab8edd0bacb20534328db8f1df216
Notes
Notes (review): Code-Review+2: Felipe Monteiro <felipe.monteiro@att.com> Code-Review+2: Pete Birley <petebirley@gmail.com> Workflow+1: Pete Birley <petebirley@gmail.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Mon, 01 Oct 2018 12:10:54 +0000 Reviewed-on: https://review.openstack.org/602611 Project: openstack/airship-berth Branch: refs/heads/master
-rw-r--r--.gitignore2
-rw-r--r--.zuul.yaml17
-rw-r--r--Makefile8
-rw-r--r--README.md3
-rw-r--r--doc/requirements.txt7
-rw-r--r--doc/source/_static/.placeholder (renamed from docs/source/_static/.placeholder)0
-rw-r--r--doc/source/conf.py (renamed from docs/source/conf.py)0
-rw-r--r--doc/source/index.rst (renamed from docs/source/index.rst)0
-rw-r--r--doc/source/readme.rst (renamed from docs/source/readme.rst)0
-rw-r--r--setup.cfg4
-rw-r--r--tox.ini4
11 files changed, 41 insertions, 4 deletions
diff --git a/.gitignore b/.gitignore
index b369923..e265c54 100644
--- a/.gitignore
+++ b/.gitignore
@@ -68,7 +68,7 @@ instance/
68.scrapy 68.scrapy
69 69
70# Sphinx documentation 70# Sphinx documentation
71docs/_build/ 71doc/_build/
72 72
73# PyBuilder 73# PyBuilder
74target/ 74target/
diff --git a/.zuul.yaml b/.zuul.yaml
new file mode 100644
index 0000000..8dddcdf
--- /dev/null
+++ b/.zuul.yaml
@@ -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'
diff --git a/Makefile b/Makefile
index e052ae7..20ddde0 100644
--- a/Makefile
+++ b/Makefile
@@ -34,6 +34,14 @@ build:
34 34
35clean: 35clean:
36 rm -f *~ */*~ */*/*~ berth-0.1.0.tgz 36 rm -f *~ */*~ */*/*~ berth-0.1.0.tgz
37 rm -rf doc/build
38
39.PHONY: docs
40docs: clean build_docs
41
42.PHONY: build_docs
43build_docs:
44 tox -e docs
37 45
38.PHONY: 46.PHONY:
39 all default build clean test-validate test-install test-uninstall 47 all default build clean test-validate test-install test-uninstall
diff --git a/README.md b/README.md
index b3dc4b6..baa6036 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,8 @@
1Berth is a deliberately minimalist VM runner for Kubernetes. 1Berth is a deliberately minimalist VM runner for Kubernetes.
2 2
3Find more documentation for Berth on
4`Read the Docs <https://airship-berth.readthedocs.io/>`_.
5
3## TL;DR Installation Guide 6## TL;DR Installation Guide
4 7
5Install the bare Berth chart: 8Install the bare Berth chart:
diff --git a/doc/requirements.txt b/doc/requirements.txt
new file mode 100644
index 0000000..101a16f
--- /dev/null
+++ b/doc/requirements.txt
@@ -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.
4sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
5sphinxcontrib-apidoc>=0.2.0 # BSD
6sphinx_rtd_theme>=0.2.4
7reno>=2.5.0 # Apache-2.0
diff --git a/docs/source/_static/.placeholder b/doc/source/_static/.placeholder
index e69de29..e69de29 100644
--- a/docs/source/_static/.placeholder
+++ b/doc/source/_static/.placeholder
diff --git a/docs/source/conf.py b/doc/source/conf.py
index 4bd3229..4bd3229 100644
--- a/docs/source/conf.py
+++ b/doc/source/conf.py
diff --git a/docs/source/index.rst b/doc/source/index.rst
index 0ba30cc..0ba30cc 100644
--- a/docs/source/index.rst
+++ b/doc/source/index.rst
diff --git a/docs/source/readme.rst b/doc/source/readme.rst
index 38ba804..38ba804 100644
--- a/docs/source/readme.rst
+++ b/doc/source/readme.rst
diff --git a/setup.cfg b/setup.cfg
index a61cde0..4fea7cc 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -21,8 +21,8 @@ packages =
21 berth 21 berth
22 22
23[build_sphinx] 23[build_sphinx]
24source-dir = docs/source 24source-dir = doc/source
25build-dir = docs/build 25build-dir = doc/build
26all_files = 1 26all_files = 1
27warning-is-error = 1 27warning-is-error = 1
28 28
diff --git a/tox.ini b/tox.ini
index edf635e..39871f2 100644
--- a/tox.ini
+++ b/tox.ini
@@ -18,6 +18,8 @@ commands =
18commands = {posargs} 18commands = {posargs}
19 19
20[testenv:docs] 20[testenv:docs]
21basepython = python3
22deps = -r{toxinidir}/doc/requirements.txt
21commands = 23commands =
22 rm -rf doc/build 24 rm -rf doc/build
23 python setup.py build_sphinx {posargs} 25 sphinx-build -W -b html doc/source doc/build/html