summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorScott Hussey <sh8121@att.com>2018-07-30 14:41:59 -0500
committerScott Hussey <sh8121@att.com>2018-08-06 21:41:39 -0500
commit7c90da14b4b3f48f953c411d93421d570577a628 (patch)
treec896f8202292501ccbc60c33c397002b6631bfbb
parentf68ca30bd7e39a496b0265861800665a45758a5e (diff)
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
Notes
Notes (review): Code-Review+1: Matt McEuen <matt.mceuen@att.com> Code-Review+1: wangqi <wang.qi@99cloud.net> Code-Review+2: Aaron Sheffield <ajs@sheffieldfamily.net> Code-Review+2: Felipe Monteiro <felipe.monteiro@att.com> Workflow+1: Aaron Sheffield <ajs@sheffieldfamily.net> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Tue, 14 Aug 2018 14:57:33 +0000 Reviewed-on: https://review.openstack.org/587207 Project: openstack/airship-in-a-bottle Branch: refs/heads/master
-rw-r--r--.gitignore6
-rw-r--r--Makefile17
-rw-r--r--doc/requirements.txt (renamed from docs/requirements.txt)0
-rw-r--r--doc/source/alarming-conditions.rst (renamed from docs/source/alarming-conditions.rst)0
-rw-r--r--doc/source/api-conventions.rst (renamed from docs/source/api-conventions.rst)0
-rw-r--r--doc/source/client-software.rst (renamed from docs/source/client-software.rst)0
-rw-r--r--doc/source/code-conventions.rst (renamed from docs/source/code-conventions.rst)0
-rw-r--r--doc/source/conf.py (renamed from docs/source/conf.py)0
-rw-r--r--doc/source/conventions.rst (renamed from docs/source/conventions.rst)0
-rw-r--r--doc/source/dev-getting-started.rst (renamed from docs/source/dev-getting-started.rst)0
-rw-r--r--doc/source/documentation-conventions.rst (renamed from docs/source/documentation-conventions.rst)0
-rw-r--r--doc/source/docutils.conf (renamed from docs/source/docutils.conf)0
-rw-r--r--doc/source/index.rst (renamed from docs/source/index.rst)8
-rw-r--r--doc/source/rbac-conventions.rst (renamed from docs/source/rbac-conventions.rst)0
-rw-r--r--doc/source/security-conventions.rst (renamed from docs/source/security-conventions.rst)0
-rw-r--r--doc/source/service-logging-conventions.rst (renamed from docs/source/service-logging-conventions.rst)0
-rw-r--r--doc/source/ucp-basic-deployment.rst (renamed from docs/source/ucp-basic-deployment.rst)0
-rw-r--r--tox.ini19
18 files changed, 47 insertions, 3 deletions
diff --git a/.gitignore b/.gitignore
index c582ac2..a9ed382 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,6 +1,6 @@
1# Sphinx documentation 1# Sphinx documentation
2docs/_build/ 2doc/_build/
3docs/build/ 3doc/build/
4 4
5# OSX folder settings files 5# OSX folder settings files
6.DS_Store \ No newline at end of file 6.DS_Store
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..984020f
--- /dev/null
+++ b/Makefile
@@ -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
16docs:
17 tox -e docs
diff --git a/docs/requirements.txt b/doc/requirements.txt
index ddc6a29..ddc6a29 100644
--- a/docs/requirements.txt
+++ b/doc/requirements.txt
diff --git a/docs/source/alarming-conditions.rst b/doc/source/alarming-conditions.rst
index 5410f8f..5410f8f 100644
--- a/docs/source/alarming-conditions.rst
+++ b/doc/source/alarming-conditions.rst
diff --git a/docs/source/api-conventions.rst b/doc/source/api-conventions.rst
index 98c1e89..98c1e89 100644
--- a/docs/source/api-conventions.rst
+++ b/doc/source/api-conventions.rst
diff --git a/docs/source/client-software.rst b/doc/source/client-software.rst
index b86d83c..b86d83c 100644
--- a/docs/source/client-software.rst
+++ b/doc/source/client-software.rst
diff --git a/docs/source/code-conventions.rst b/doc/source/code-conventions.rst
index 47919d7..47919d7 100644
--- a/docs/source/code-conventions.rst
+++ b/doc/source/code-conventions.rst
diff --git a/docs/source/conf.py b/doc/source/conf.py
index 334d574..334d574 100644
--- a/docs/source/conf.py
+++ b/doc/source/conf.py
diff --git a/docs/source/conventions.rst b/doc/source/conventions.rst
index 146617e..146617e 100644
--- a/docs/source/conventions.rst
+++ b/doc/source/conventions.rst
diff --git a/docs/source/dev-getting-started.rst b/doc/source/dev-getting-started.rst
index 3ffcbba..3ffcbba 100644
--- a/docs/source/dev-getting-started.rst
+++ b/doc/source/dev-getting-started.rst
diff --git a/docs/source/documentation-conventions.rst b/doc/source/documentation-conventions.rst
index 8ceb3af..8ceb3af 100644
--- a/docs/source/documentation-conventions.rst
+++ b/doc/source/documentation-conventions.rst
diff --git a/docs/source/docutils.conf b/doc/source/docutils.conf
index b49cd48..b49cd48 100644
--- a/docs/source/docutils.conf
+++ b/doc/source/docutils.conf
diff --git a/docs/source/index.rst b/doc/source/index.rst
index 4ae4c8e..479258e 100644
--- a/docs/source/index.rst
+++ b/doc/source/index.rst
@@ -45,6 +45,12 @@ Use of ``sphinx-build -b html docs/source docs/build`` will build a html
45version of this documentation that can be viewed using a browser at 45version of this documentation that can be viewed using a browser at
46docs/build/index.html on the local filesystem. 46docs/build/index.html on the local filesystem.
47 47
48Specification Details
49---------------------
50
51Proposed, approved, and implemented specifications_ for
52Airship projects are available.
53
48Conventions and Standards 54Conventions and Standards
49------------------------- 55-------------------------
50 56
@@ -53,6 +59,7 @@ Conventions and Standards
53 59
54 conventions 60 conventions
55 dev-getting-started 61 dev-getting-started
62 ucp-basic-deployment
56 63
57 64
58.. _airshipit.org: https://airshipit.org 65.. _airshipit.org: https://airshipit.org
@@ -62,3 +69,4 @@ Conventions and Standards
62.. _Openstack-Helm: https://docs.openstack.org/openstack-helm/latest/ 69.. _Openstack-Helm: https://docs.openstack.org/openstack-helm/latest/
63.. _Treasuremap: https://github.com/att-comdev/treasuremap 70.. _Treasuremap: https://github.com/att-comdev/treasuremap
64.. _yaml: http://yaml.org/ 71.. _yaml: http://yaml.org/
72.. _specifications: /projects/specs
diff --git a/docs/source/rbac-conventions.rst b/doc/source/rbac-conventions.rst
index 665aa73..665aa73 100644
--- a/docs/source/rbac-conventions.rst
+++ b/doc/source/rbac-conventions.rst
diff --git a/docs/source/security-conventions.rst b/doc/source/security-conventions.rst
index 0039879..0039879 100644
--- a/docs/source/security-conventions.rst
+++ b/doc/source/security-conventions.rst
diff --git a/docs/source/service-logging-conventions.rst b/doc/source/service-logging-conventions.rst
index 4f0c9f2..4f0c9f2 100644
--- a/docs/source/service-logging-conventions.rst
+++ b/doc/source/service-logging-conventions.rst
diff --git a/docs/source/ucp-basic-deployment.rst b/doc/source/ucp-basic-deployment.rst
index 2a93044..2a93044 100644
--- a/docs/source/ucp-basic-deployment.rst
+++ b/doc/source/ucp-basic-deployment.rst
diff --git a/tox.ini b/tox.ini
new file mode 100644
index 0000000..41951a3
--- /dev/null
+++ b/tox.ini
@@ -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).
4skipsdist = True
5envlist = docs
6
7[testenv]
8passenv=HTTP_PROXY HTTPS_PROXY http_proxy https_proxy NO_PROXY no_proxy
9setenv=
10 VIRTUAL_ENV={envdir}
11install_command = pip install {opts} {packages}
12
13[testenv:docs]
14basepython = python3
15deps = -r{toxinidir}/doc/requirements.txt
16commands =
17 rm -rf doc/build
18 sphinx-build -W -b html doc/source doc/build/html
19whitelist_externals = rm