Browse Source

Set up publishing of docs

Set up publishing of docs to the readthedocs.

Change-Id: Id9ac3fecb30b28932471e7fedf1d520faefdc703
tags/v18.11.01
Roman Gorshunov 1 year ago
parent
commit
6ca369f277
12 changed files with 54 additions and 4 deletions
  1. +3
    -1
      .zuul.yaml
  2. +27
    -0
      Makefile
  3. +0
    -0
      doc/requirements.txt
  4. +3
    -3
      doc/source/authoring_and_deployment.rst
  5. +0
    -0
      doc/source/conf.py
  6. +0
    -0
      doc/source/diagrams/architecture.png
  7. +0
    -0
      doc/source/diagrams/component_list.png
  8. +0
    -0
      doc/source/diagrams/deploy_site.png
  9. +0
    -0
      doc/source/diagrams/genesis.png
  10. +0
    -0
      doc/source/index.rst
  11. +0
    -0
      doc/source/seaworthy.rst
  12. +21
    -0
      tox.ini

+ 3
- 1
.zuul.yaml View File

@@ -12,4 +12,6 @@

- project:
templates:
- noop-jobs
- docs-on-readthedocs
vars:
rtd_webhook_id: '47687'

+ 27
- 0
Makefile 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

docs/requirements.txt → doc/requirements.txt View File


docs/source/authoring_and_deployment.rst → doc/source/authoring_and_deployment.rst View File

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

docs/source/conf.py → doc/source/conf.py View File


docs/source/diagrams/architecture.png → doc/source/diagrams/architecture.png View File


docs/source/diagrams/component_list.png → doc/source/diagrams/component_list.png View File


docs/source/diagrams/deploy_site.png → doc/source/diagrams/deploy_site.png View File


docs/source/diagrams/genesis.png → doc/source/diagrams/genesis.png View File


docs/source/index.rst → doc/source/index.rst View File


docs/source/seaworthy.rst → doc/source/seaworthy.rst View File


+ 21
- 0
tox.ini 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

Loading…
Cancel
Save