summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTin Lam <tin@irrational.io>2018-05-19 23:40:45 -0500
committerTin Lam <tin@irrational.io>2018-05-22 14:26:20 -0500
commit4e074ec0c24ec285dc3ac02e2a347a0033dad454 (patch)
treeea50629a8dccc609baeb7a26de7185170a5cb100
parent1f6f6c98c38c617362637a599a435d6789f111c2 (diff)
docs(tox): Add tox target to generate docs
This patch set: (a) renamed the docs folder to doc (b) add in a basic tox.ini to generate the doc via ``tox -edocs`` (c) add in necessary /docs/requirements.txt dependencies Change-Id: Id45db34fdc8860047047a4e6069483dfb4a56d7f Signed-off-by: Tin Lam <tin@irrational.io>
Notes
Notes (review): Code-Review+2: Felipe Monteiro <felipe.monteiro@att.com> Code-Review+2: Scott Hussey <sthussey@att.com> Workflow+1: Scott Hussey <sthussey@att.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Thu, 31 May 2018 14:28:11 +0000 Reviewed-on: https://review.openstack.org/569630 Project: openstack/airship-divingbell Branch: refs/heads/master
-rw-r--r--doc/requirements.txt9
-rw-r--r--doc/source/conf.py (renamed from docs/source/conf.py)0
-rw-r--r--doc/source/index.rst (renamed from docs/source/index.rst)0
-rw-r--r--setup.cfg23
-rw-r--r--setup.py27
-rw-r--r--test-requirements.txt0
-rw-r--r--tox.ini23
7 files changed, 82 insertions, 0 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt
new file mode 100644
index 0000000..324d202
--- /dev/null
+++ b/doc/requirements.txt
@@ -0,0 +1,9 @@
1# The order of packages is significant, because pip processes them in the order
2# of appearance. Changing the order has an impact on the overall integration
3# process, which may cause wedges in the gate later.
4openstackdocstheme>=1.18.1 # Apache-2.0
5sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
6sphinxcontrib-apidoc>=0.2.0 # BSD
7reno>=2.5.0 # Apache-2.0
8os-api-ref>=1.4.0 # Apache-2.0
9sphinx_rtd_theme
diff --git a/docs/source/conf.py b/doc/source/conf.py
index 03c8794..03c8794 100644
--- a/docs/source/conf.py
+++ b/doc/source/conf.py
diff --git a/docs/source/index.rst b/doc/source/index.rst
index 05f85b0..05f85b0 100644
--- a/docs/source/index.rst
+++ b/doc/source/index.rst
diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 0000000..f0006ee
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,23 @@
1[metadata]
2name = divingbell
3description-file = README.md
4author = OpenStack
5home-page =
6classifier =
7 Intended Audience :: Information Technology
8 Intended Audience :: System Administrators
9 License :: OSI Approved :: Apache Software License
10 Operating System :: POSIX :: Linux
11 Programming Language :: Shellscript
12
13[build_sphinx]
14source-dir = doc/source
15build-dir = doc/build
16all_files = 1
17warning-is-error = 1
18
19[upload_sphinx]
20upload-dir = doc/build/html
21
22[pbr]
23warnerrors = True
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000..d74ff58
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,27 @@
1# Licensed under the Apache License, Version 2.0 (the "License");
2# you may not use this file except in compliance with the License.
3# You may obtain a copy of the License at
4#
5# http://www.apache.org/licenses/LICENSE-2.0
6#
7# Unless required by applicable law or agreed to in writing, software
8# distributed under the License is distributed on an "AS IS" BASIS,
9# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
10# implied.
11# See the License for the specific language governing permissions and
12# limitations under the License.
13
14# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT
15import setuptools
16
17# In python < 2.7.4, a lazy loading of package `pbr` will break
18# setuptools if some other modules registered functions in `atexit`.
19# solution from: http://bugs.python.org/issue15881#msg170215
20try:
21 import multiprocessing # noqa
22except ImportError:
23 pass
24
25setuptools.setup(
26 setup_requires=['pbr>=2.0.0'],
27 pbr=True)
diff --git a/test-requirements.txt b/test-requirements.txt
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/test-requirements.txt
diff --git a/tox.ini b/tox.ini
new file mode 100644
index 0000000..dda4b08
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,23 @@
1[tox]
2minversion = 2.3.1
3skipsdist = True
4envlist = docs
5
6[testenv]
7usedevelop = True
8passenv = http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY PBR_VERSION
9setenv = VIRTUAL_ENV={envdir}
10install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages}
11deps = -r{toxinidir}/test-requirements.txt
12commands =
13
14[testenv:docs]
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 =
20 rm
21
22[testenv:venv]
23commands = {posargs}