Browse Source

Initial commit

Add tox logic for tox -edocs and tox -epep8 for the gate.

Change-Id: Idfa0602edbf5f34e44d287e7511c02b34eab4e7f
Signed-off-by: Paul Belanger <pabelanger@redhat.com>
changes/13/274213/1
Paul Belanger 6 years ago
parent
commit
a90bef81ba
  1. 4
      .gitignore
  2. 16
      README.rst
  3. 73
      doc/source/conf.py
  4. 1
      doc/source/index.rst
  5. 1
      requirements.txt
  6. 28
      setup.cfg
  7. 28
      setup.py
  8. 2
      test-requirements.txt
  9. 25
      tox.ini

4
.gitignore vendored

@ -0,0 +1,4 @@
.tox/
AUTHORS
ChangeLog
doc/build/

16
README.rst

@ -0,0 +1,16 @@
========
windmill
========
An Ansible deployment to validate ansible roles for Continuous Integration
* License: Apache License, Version 2.0
* Documentation: https://windmill.readthedocs.org
* Source: https://git.openstack.org/cgit/openstack/windmill
* Bugs: https://bugs.launchpad.net/windmill
Description
-----------
Windmill is a collection of Ansible playbooks and roles used to deploy
Continuous Integration (CI) tools.

73
doc/source/conf.py

@ -0,0 +1,73 @@
# -*- coding: utf-8 -*-
# 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.
import os
import sys
sys.path.insert(0, os.path.abspath('../..'))
# -- General configuration ----------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'sphinx.ext.autodoc',
]
# autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles.
# execute "export SPHINX_DEBUG=1" in your terminal to disable
# The suffix of source filenames.
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'windmill'
copyright = u'2013, OpenStack Foundation'
# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
add_module_names = True
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
# html_theme_path = ["."]
# html_theme = '_theme'
# html_static_path = ['static']
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
# [howto/manual]).
latex_documents = [
('index',
'%s.tex' % project,
u'%s Documentation' % project,
u'OpenStack Foundation', 'manual'),
]
# Example configuration for intersphinx: refer to the Python standard library.
# intersphinx_mapping = {'http://docs.python.org/': None}

1
doc/source/index.rst

@ -0,0 +1 @@
.. include:: ../../README.rst

1
requirements.txt

@ -0,0 +1 @@
ansible>=2.0

28
setup.cfg

@ -0,0 +1,28 @@
[metadata]
name = windmill
summary = Ansible deployment for Continuous Integration (CI)
description-file =
README.rst
author = OpenStack
author-email = openstack-dev@lists.openstack.org
home-page = http://www.openstack.org/
classifier =
Environment :: OpenStack
Intended Audience :: Information Technology
Intended Audience :: System Administrators
License :: OSI Approved :: Apache Software License
Operating System :: POSIX :: Linux
Programming Language :: Python
Programming Language :: Python :: 2
Programming Language :: Python :: 2.7
Programming Language :: Python :: 3
Programming Language :: Python :: 3.3
Programming Language :: Python :: 3.4
[build_sphinx]
all_files = 1
build-dir = doc/build
source-dir = doc/source
[pbr]
warnerrors = True

28
setup.py

@ -0,0 +1,28 @@
# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
#
# 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.
import setuptools
# In python < 2.7.4, a lazy loading of package `pbr` will break
# setuptools if some other modules registered functions in `atexit`.
# solution from: http://bugs.python.org/issue15881#msg170215
try:
import multiprocessing # noqa
except ImportError:
pass
setuptools.setup(
setup_requires=['pbr'],
pbr=True)

2
test-requirements.txt

@ -0,0 +1,2 @@
hacking<0.11,>=0.10
sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3

25
tox.ini

@ -0,0 +1,25 @@
[tox]
minversion = 1.4.2
envlist = docs,pep8
skipsdist = True
[testenv]
deps = -r{toxinidir}/requirements.txt
-r{toxinidir}/test-requirements.txt
[testenv:docs]
commands = python setup.py build_sphinx
[testenv:pep8]
commands = flake8
[testenv:venv]
commands = {posargs}
[flake8]
# E123, E125 skipped as they are invalid PEP-8.
show-source = True
ignore = E123,E125
builtins = _
exclude=.venv,.git,.tox,dist,doc,*openstack/common*,*lib/python*,*egg,build
Loading…
Cancel
Save