Browse Source

docs: Add doc building jobs and doc index page with link

* Rename docs => doc for OpenStack convention compliance
* Add tox.ini job for docs building (no setup.py required)
* Add Makefile with docs entrypoint
* Add a link to the airship-specs subproject.

Change-Id: I835633405b3dac671aa123eb4ee04645f390c352
changes/07/587207/9
Scott Hussey 9 months ago
parent
commit
7c90da14b4

+ 3
- 3
.gitignore View File

@@ -1,6 +1,6 @@
1 1
 # Sphinx documentation
2
-docs/_build/
3
-docs/build/
2
+doc/_build/
3
+doc/build/
4 4
 
5 5
 # OSX folder settings files
6
-.DS_Store
6
+.DS_Store

+ 17
- 0
Makefile View File

@@ -0,0 +1,17 @@
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: docs
16
+docs:
17
+	tox -e docs

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


docs/source/alarming-conditions.rst → doc/source/alarming-conditions.rst View File


docs/source/api-conventions.rst → doc/source/api-conventions.rst View File


docs/source/client-software.rst → doc/source/client-software.rst View File


docs/source/code-conventions.rst → doc/source/code-conventions.rst View File


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


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


docs/source/dev-getting-started.rst → doc/source/dev-getting-started.rst View File


docs/source/documentation-conventions.rst → doc/source/documentation-conventions.rst View File


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


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

@@ -45,6 +45,12 @@ Use of ``sphinx-build -b html docs/source docs/build`` will build a html
45 45
 version of this documentation that can be viewed using a browser at
46 46
 docs/build/index.html on the local filesystem.
47 47
 
48
+Specification Details
49
+---------------------
50
+
51
+Proposed, approved, and implemented specifications_ for
52
+Airship projects are available.
53
+
48 54
 Conventions and Standards
49 55
 -------------------------
50 56
 
@@ -53,6 +59,7 @@ Conventions and Standards
53 59
 
54 60
    conventions
55 61
    dev-getting-started
62
+   ucp-basic-deployment
56 63
 
57 64
 
58 65
 .. _airshipit.org: https://airshipit.org
@@ -62,3 +69,4 @@ Conventions and Standards
62 69
 .. _Openstack-Helm: https://docs.openstack.org/openstack-helm/latest/
63 70
 .. _Treasuremap: https://github.com/att-comdev/treasuremap
64 71
 .. _yaml: http://yaml.org/
72
+.. _specifications: /projects/specs

docs/source/rbac-conventions.rst → doc/source/rbac-conventions.rst View File


docs/source/security-conventions.rst → doc/source/security-conventions.rst View File


docs/source/service-logging-conventions.rst → doc/source/service-logging-conventions.rst View File


docs/source/ucp-basic-deployment.rst → doc/source/ucp-basic-deployment.rst View File


+ 19
- 0
tox.ini View File

@@ -0,0 +1,19 @@
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
+envlist = docs
6
+
7
+[testenv]
8
+passenv=HTTP_PROXY HTTPS_PROXY http_proxy https_proxy NO_PROXY no_proxy
9
+setenv=
10
+    VIRTUAL_ENV={envdir}
11
+install_command = pip install {opts} {packages}
12
+
13
+[testenv:docs]
14
+basepython = python3
15
+deps = -r{toxinidir}/doc/requirements.txt
16
+commands =
17
+    rm -rf doc/build
18
+    sphinx-build -W -b html doc/source doc/build/html
19
+whitelist_externals = rm

Loading…
Cancel
Save