Set up publishing of docs
Set up publishing of docs to the readthedocs. Change-Id: If42d4fa5937ab8edd0bacb20534328db8f1df216
This commit is contained in:
parent
7b6bf409d8
commit
67372bade2
|
@ -68,7 +68,7 @@ instance/
|
||||||
.scrapy
|
.scrapy
|
||||||
|
|
||||||
# Sphinx documentation
|
# Sphinx documentation
|
||||||
docs/_build/
|
doc/_build/
|
||||||
|
|
||||||
# PyBuilder
|
# PyBuilder
|
||||||
target/
|
target/
|
||||||
|
|
|
@ -0,0 +1,17 @@
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
|
||||||
|
- project:
|
||||||
|
templates:
|
||||||
|
- docs-on-readthedocs
|
||||||
|
vars:
|
||||||
|
rtd_webhook_id: '47941'
|
8
Makefile
8
Makefile
|
@ -34,6 +34,14 @@ build:
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
rm -f *~ */*~ */*/*~ berth-0.1.0.tgz
|
rm -f *~ */*~ */*/*~ berth-0.1.0.tgz
|
||||||
|
rm -rf doc/build
|
||||||
|
|
||||||
|
.PHONY: docs
|
||||||
|
docs: clean build_docs
|
||||||
|
|
||||||
|
.PHONY: build_docs
|
||||||
|
build_docs:
|
||||||
|
tox -e docs
|
||||||
|
|
||||||
.PHONY:
|
.PHONY:
|
||||||
all default build clean test-validate test-install test-uninstall
|
all default build clean test-validate test-install test-uninstall
|
||||||
|
|
|
@ -1,5 +1,8 @@
|
||||||
Berth is a deliberately minimalist VM runner for Kubernetes.
|
Berth is a deliberately minimalist VM runner for Kubernetes.
|
||||||
|
|
||||||
|
Find more documentation for Berth on
|
||||||
|
`Read the Docs <https://airship-berth.readthedocs.io/>`_.
|
||||||
|
|
||||||
## TL;DR Installation Guide
|
## TL;DR Installation Guide
|
||||||
|
|
||||||
Install the bare Berth chart:
|
Install the bare Berth chart:
|
||||||
|
|
|
@ -0,0 +1,7 @@
|
||||||
|
# The order of packages is significant, because pip processes them in the order
|
||||||
|
# of appearance. Changing the order has an impact on the overall integration
|
||||||
|
# process, which may cause wedges in the gate later.
|
||||||
|
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
|
||||||
|
sphinxcontrib-apidoc>=0.2.0 # BSD
|
||||||
|
sphinx_rtd_theme>=0.2.4
|
||||||
|
reno>=2.5.0 # Apache-2.0
|
|
@ -21,8 +21,8 @@ packages =
|
||||||
berth
|
berth
|
||||||
|
|
||||||
[build_sphinx]
|
[build_sphinx]
|
||||||
source-dir = docs/source
|
source-dir = doc/source
|
||||||
build-dir = docs/build
|
build-dir = doc/build
|
||||||
all_files = 1
|
all_files = 1
|
||||||
warning-is-error = 1
|
warning-is-error = 1
|
||||||
|
|
||||||
|
|
4
tox.ini
4
tox.ini
|
@ -18,6 +18,8 @@ commands =
|
||||||
commands = {posargs}
|
commands = {posargs}
|
||||||
|
|
||||||
[testenv:docs]
|
[testenv:docs]
|
||||||
|
basepython = python3
|
||||||
|
deps = -r{toxinidir}/doc/requirements.txt
|
||||||
commands =
|
commands =
|
||||||
rm -rf doc/build
|
rm -rf doc/build
|
||||||
python setup.py build_sphinx {posargs}
|
sphinx-build -W -b html doc/source doc/build/html
|
||||||
|
|
Loading…
Reference in New Issue