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
This commit is contained in:
Scott Hussey 2018-07-30 14:41:59 -05:00
parent f68ca30bd7
commit 7c90da14b4
18 changed files with 47 additions and 3 deletions

6
.gitignore vendored
View File

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

17
Makefile Normal file
View File

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

View File

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

19
tox.ini Normal file
View File

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