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

+ 3
- 1
.zuul.yaml View File

@@ -12,4 +12,6 @@
12 12
 
13 13
 - project:
14 14
     templates:
15
-      - noop-jobs
15
+      - docs-on-readthedocs
16
+    vars:
17
+      rtd_webhook_id: '47687'

+ 27
- 0
Makefile View File

@@ -0,0 +1,27 @@
1
+# Copyright 2017 AT&T Intellectual Property.  All other rights reserved.
2
+#
3
+# Licensed under the Apache License, Version 2.0 (the "License");
4
+# you may not use this file except in compliance with the License.
5
+# You may obtain a copy of the License at
6
+#
7
+#     http://www.apache.org/licenses/LICENSE-2.0
8
+#
9
+# Unless required by applicable law or agreed to in writing, software
10
+# distributed under the License is distributed on an "AS IS" BASIS,
11
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+# See the License for the specific language governing permissions and
13
+# limitations under the License.
14
+
15
+.PHONY: all
16
+all: docs
17
+
18
+.PHONY: clean
19
+clean:
20
+	rm -rf doc/build
21
+
22
+.PHONY: docs
23
+docs: clean build_docs
24
+
25
+.PHONY: build_docs
26
+build_docs:
27
+	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
105 105
 -------------
106 106
 
107 107
 Disk
108
-^^^^
108
+~~~~
109 109
 
110 110
 1. Control plane server disks:
111 111
 
@@ -120,7 +120,7 @@ Disk
120 120
      for each given server (e.g., RAID-10).
121 121
 
122 122
 BIOS and IPMI
123
-^^^^^^^^^^^^^
123
+~~~~~~~~~~~~~
124 124
 
125 125
 1. Virtualization enabled in BIOS
126 126
 2. IPMI enabled in server BIOS (e.g., IPMI over LAN option enabled)
@@ -132,7 +132,7 @@ BIOS and IPMI
132 132
 4. Set PXE as first boot device and ensure the correct NIC is selected for PXE
133 133
 
134 134
 Network
135
-^^^^^^^
135
+~~~~~~~
136 136
 
137 137
 1. You have a network you can successfully PXE boot with your network topology
138 138
    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 @@
1
+[tox]
2
+# Allows docs to be built without setup.py having to exist. Requires that
3
+# usedevelop be False as well (which it is by default).
4
+skipsdist = True
5
+
6
+[testenv]
7
+setenv = VIRTUAL_ENV={envdir}
8
+         LANGUAGE=en_US
9
+         LC_ALL=en_US.utf-8
10
+passenv = http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY
11
+
12
+[testenv:venv]
13
+commands = {posargs}
14
+
15
+[testenv:docs]
16
+basepython = python3
17
+whitelist_externals = rm
18
+deps = -r{toxinidir}/doc/requirements.txt
19
+commands =
20
+    rm -rf doc/build
21
+    sphinx-build -W -b html doc/source doc/build/html

Loading…
Cancel
Save