Browse Source

Set up publishing of docs

Set up publishing of docs to the readthedocs.

Change-Id: Id9ac3fecb30b28932471e7fedf1d520faefdc703
changes/13/602613/9
Roman Gorshunov 3 years ago
parent
commit
6ca369f277
  1. 4
      .zuul.yaml
  2. 27
      Makefile
  3. 0
      doc/requirements.txt
  4. 6
      doc/source/authoring_and_deployment.rst
  5. 0
      doc/source/conf.py
  6. 0
      doc/source/diagrams/architecture.png
  7. 0
      doc/source/diagrams/component_list.png
  8. 0
      doc/source/diagrams/deploy_site.png
  9. 0
      doc/source/diagrams/genesis.png
  10. 0
      doc/source/index.rst
  11. 0
      doc/source/seaworthy.rst
  12. 21
      tox.ini

4
.zuul.yaml

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

27
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

0
docs/requirements.txt → doc/requirements.txt

6
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

0
docs/source/conf.py → doc/source/conf.py

0
docs/source/diagrams/architecture.png → doc/source/diagrams/architecture.png

Before

Width:  |  Height:  |  Size: 375 KiB

After

Width:  |  Height:  |  Size: 375 KiB

0
docs/source/diagrams/component_list.png → doc/source/diagrams/component_list.png

Before

Width:  |  Height:  |  Size: 70 KiB

After

Width:  |  Height:  |  Size: 70 KiB

0
docs/source/diagrams/deploy_site.png → doc/source/diagrams/deploy_site.png

Before

Width:  |  Height:  |  Size: 177 KiB

After

Width:  |  Height:  |  Size: 177 KiB

0
docs/source/diagrams/genesis.png → doc/source/diagrams/genesis.png

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 39 KiB

0
docs/source/index.rst → doc/source/index.rst

0
docs/source/seaworthy.rst → doc/source/seaworthy.rst

21
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
Loading…
Cancel
Save