Set up publishing of docs

Set up publishing of docs to the readthedocs. Change-Id: Id9ac3fecb30b28932471e7fedf1d520faefdc703
airshipit · Sep 28, 2018 · 6ca369f · 6ca369f
1 parent dd64cd9
commit 6ca369f
Show file tree

Hide file tree

Showing 12 changed files with 54 additions and 4 deletions.
diff --git a/.zuul.yaml b/.zuul.yaml
@@ -12,4 +12,6 @@
 
 - project:
     templates:
-      - noop-jobs
+      - docs-on-readthedocs
+    vars:
+      rtd_webhook_id: '47687'
diff --git a/Makefile b/Makefile
@@ -0,0 +1,27 @@
+# Copyright 2017 AT&T Intellectual Property.  All other rights reserved.
+#
+# 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.
+
+.PHONY: all
+all: docs
+
+.PHONY: clean
+clean:
+	rm -rf doc/build
+
+.PHONY: docs
+docs: clean build_docs
+
+.PHONY: build_docs
+build_docs:
+	tox -e docs
diff --git a/docs/requirements.txt → doc/requirements.txt b/docs/requirements.txt → doc/requirements.txt
diff --git a/docs/source/authoring_and_deployment.rst → doc/source/authoring_and_deployment.rst b/docs/source/authoring_and_deployment.rst → doc/source/authoring_and_deployment.rst
@@ -105,7 +105,7 @@ Hardware Prep
 -------------
 
 Disk
-^^^^
+~~~~
 
 1. Control plane server disks:
 
@@ -120,7 +120,7 @@ Disk
      for each given server (e.g., RAID-10).
 
 BIOS and IPMI
-^^^^^^^^^^^^^
+~~~~~~~~~~~~~
 
 1. Virtualization enabled in BIOS
 2. IPMI enabled in server BIOS (e.g., IPMI over LAN option enabled)
@@ -132,7 +132,7 @@ BIOS and IPMI
 4. Set PXE as first boot device and ensure the correct NIC is selected for PXE
 
 Network
-^^^^^^^
+~~~~~~~
 
 1. You have a network you can successfully PXE boot with your network topology
    and bonding settings (dedicated PXE interace on untagged/native VLAN in this

diff --git a/docs/source/conf.py → doc/source/conf.py b/docs/source/conf.py → doc/source/conf.py
diff --git a/docs/source/diagrams/architecture.png → doc/source/diagrams/architecture.png b/docs/source/diagrams/architecture.png → doc/source/diagrams/architecture.png
diff --git a/docs/source/diagrams/component_list.png → doc/source/diagrams/component_list.png b/docs/source/diagrams/component_list.png → doc/source/diagrams/component_list.png
diff --git a/docs/source/diagrams/deploy_site.png → doc/source/diagrams/deploy_site.png b/docs/source/diagrams/deploy_site.png → doc/source/diagrams/deploy_site.png
diff --git a/docs/source/diagrams/genesis.png → doc/source/diagrams/genesis.png b/docs/source/diagrams/genesis.png → doc/source/diagrams/genesis.png
diff --git a/docs/source/index.rst → doc/source/index.rst b/docs/source/index.rst → doc/source/index.rst
diff --git a/docs/source/seaworthy.rst → doc/source/seaworthy.rst b/docs/source/seaworthy.rst → doc/source/seaworthy.rst
diff --git a/tox.ini b/tox.ini
@@ -0,0 +1,21 @@
+[tox]
+# Allows docs to be built without setup.py having to exist. Requires that
+# usedevelop be False as well (which it is by default).
+skipsdist = True
+
+[testenv]
+setenv = VIRTUAL_ENV={envdir}
+         LANGUAGE=en_US
+         LC_ALL=en_US.utf-8
+passenv = http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY
+
+[testenv:venv]
+commands = {posargs}
+
+[testenv:docs]
+basepython = python3
+whitelist_externals = rm
+deps = -r{toxinidir}/doc/requirements.txt
+commands =
+    rm -rf doc/build
+    sphinx-build -W -b html doc/source doc/build/html