Set up publishing of docs

Set up publishing of docs to the readthedocs.

Change-Id: Id9ac3fecb30b28932471e7fedf1d520faefdc703
This commit is contained in:
Roman Gorshunov 2018-09-28 18:49:54 +02:00
parent dd64cd93e7
commit 6ca369f277
12 changed files with 54 additions and 4 deletions

View File

@ -12,4 +12,6 @@
- project: - project:
templates: templates:
- noop-jobs - docs-on-readthedocs
vars:
rtd_webhook_id: '47687'

27
Makefile Normal file
View File

@ -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

View File

@ -105,7 +105,7 @@ Hardware Prep
------------- -------------
Disk Disk
^^^^ ~~~~
1. Control plane server disks: 1. Control plane server disks:
@ -120,7 +120,7 @@ Disk
for each given server (e.g., RAID-10). for each given server (e.g., RAID-10).
BIOS and IPMI BIOS and IPMI
^^^^^^^^^^^^^ ~~~~~~~~~~~~~
1. Virtualization enabled in BIOS 1. Virtualization enabled in BIOS
2. IPMI enabled in server BIOS (e.g., IPMI over LAN option enabled) 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 4. Set PXE as first boot device and ensure the correct NIC is selected for PXE
Network Network
^^^^^^^ ~~~~~~~
1. You have a network you can successfully PXE boot with your network topology 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 and bonding settings (dedicated PXE interace on untagged/native VLAN in this

View File

Before

Width:  |  Height:  |  Size: 375 KiB

After

Width:  |  Height:  |  Size: 375 KiB

View File

Before

Width:  |  Height:  |  Size: 70 KiB

After

Width:  |  Height:  |  Size: 70 KiB

View File

Before

Width:  |  Height:  |  Size: 177 KiB

After

Width:  |  Height:  |  Size: 177 KiB

View File

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 39 KiB

21
tox.ini Normal file
View File

@ -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