From 6ca369f277cd7068ba4d679b6e4db8987834732e Mon Sep 17 00:00:00 2001 From: Roman Gorshunov Date: Fri, 28 Sep 2018 18:49:54 +0200 Subject: [PATCH] Set up publishing of docs Set up publishing of docs to the readthedocs. Change-Id: Id9ac3fecb30b28932471e7fedf1d520faefdc703 --- .zuul.yaml | 4 ++- Makefile | 27 ++++++++++++++++++ {docs => doc}/requirements.txt | 0 .../source/authoring_and_deployment.rst | 6 ++-- {docs => doc}/source/conf.py | 0 .../source/diagrams/architecture.png | Bin .../source/diagrams/component_list.png | Bin {docs => doc}/source/diagrams/deploy_site.png | Bin {docs => doc}/source/diagrams/genesis.png | Bin {docs => doc}/source/index.rst | 0 {docs => doc}/source/seaworthy.rst | 0 tox.ini | 21 ++++++++++++++ 12 files changed, 54 insertions(+), 4 deletions(-) create mode 100644 Makefile rename {docs => doc}/requirements.txt (100%) rename {docs => doc}/source/authoring_and_deployment.rst (99%) rename {docs => doc}/source/conf.py (100%) rename {docs => doc}/source/diagrams/architecture.png (100%) rename {docs => doc}/source/diagrams/component_list.png (100%) rename {docs => doc}/source/diagrams/deploy_site.png (100%) rename {docs => doc}/source/diagrams/genesis.png (100%) rename {docs => doc}/source/index.rst (100%) rename {docs => doc}/source/seaworthy.rst (100%) create mode 100644 tox.ini diff --git a/.zuul.yaml b/.zuul.yaml index 115d77c00..f0e68376c 100644 --- 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 new file mode 100644 index 000000000..a0490d3a7 --- /dev/null +++ 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 b/doc/requirements.txt similarity index 100% rename from docs/requirements.txt rename to doc/requirements.txt diff --git a/docs/source/authoring_and_deployment.rst b/doc/source/authoring_and_deployment.rst similarity index 99% rename from docs/source/authoring_and_deployment.rst rename to doc/source/authoring_and_deployment.rst index cf8c633a9..ec5d025c8 100644 --- a/docs/source/authoring_and_deployment.rst +++ b/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 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/diagrams/architecture.png b/doc/source/diagrams/architecture.png similarity index 100% rename from docs/source/diagrams/architecture.png rename to doc/source/diagrams/architecture.png diff --git a/docs/source/diagrams/component_list.png b/doc/source/diagrams/component_list.png similarity index 100% rename from docs/source/diagrams/component_list.png rename to doc/source/diagrams/component_list.png diff --git a/docs/source/diagrams/deploy_site.png b/doc/source/diagrams/deploy_site.png similarity index 100% rename from docs/source/diagrams/deploy_site.png rename to doc/source/diagrams/deploy_site.png diff --git a/docs/source/diagrams/genesis.png b/doc/source/diagrams/genesis.png similarity index 100% rename from docs/source/diagrams/genesis.png rename to doc/source/diagrams/genesis.png 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/seaworthy.rst b/doc/source/seaworthy.rst similarity index 100% rename from docs/source/seaworthy.rst rename to doc/source/seaworthy.rst diff --git a/tox.ini b/tox.ini new file mode 100644 index 000000000..2385180d1 --- /dev/null +++ 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