diff --git a/.gitignore b/.gitignore index b369923..e265c54 100644 --- a/.gitignore +++ b/.gitignore @@ -68,7 +68,7 @@ instance/ .scrapy # Sphinx documentation -docs/_build/ +doc/_build/ # PyBuilder target/ diff --git a/.zuul.yaml b/.zuul.yaml new file mode 100644 index 0000000..8dddcdf --- /dev/null +++ b/.zuul.yaml @@ -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' diff --git a/Makefile b/Makefile index e052ae7..20ddde0 100644 --- a/Makefile +++ b/Makefile @@ -34,6 +34,14 @@ build: clean: 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: 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 @@ Berth is a deliberately minimalist VM runner for Kubernetes. +Find more documentation for Berth on +`Read the Docs `_. + ## TL;DR Installation Guide Install 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 @@ +# 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 diff --git a/docs/source/_static/.placeholder b/doc/source/_static/.placeholder similarity index 100% rename from docs/source/_static/.placeholder rename to doc/source/_static/.placeholder diff --git a/docs/source/conf.py b/doc/source/conf.py similarity index 100% rename from docs/source/conf.py rename to doc/source/conf.py diff --git a/docs/source/index.rst b/doc/source/index.rst similarity index 100% rename from docs/source/index.rst rename to doc/source/index.rst diff --git a/docs/source/readme.rst b/doc/source/readme.rst similarity index 100% rename from docs/source/readme.rst rename to 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 = berth [build_sphinx] -source-dir = docs/source -build-dir = docs/build +source-dir = doc/source +build-dir = doc/build all_files = 1 warning-is-error = 1 diff --git a/tox.ini b/tox.ini index edf635e..39871f2 100644 --- a/tox.ini +++ b/tox.ini @@ -18,6 +18,8 @@ commands = commands = {posargs} [testenv:docs] +basepython = python3 +deps = -r{toxinidir}/doc/requirements.txt commands = rm -rf doc/build - python setup.py build_sphinx {posargs} + sphinx-build -W -b html doc/source doc/build/html