From 18b8f87a6e6e14864ada56dd50612107ab2ac511 Mon Sep 17 00:00:00 2001 From: Paul Belanger Date: Wed, 18 Nov 2015 08:57:02 -0500 Subject: [PATCH] Add documentation requirements for gate Change-Id: I83ae3bb426c1a951216e2ca0509d1b5ab5020ecc Signed-off-by: Paul Belanger --- .gitignore | 3 ++ doc/source/conf.py | 73 +++++++++++++++++++++++++++++++++++++ doc/source/index.rst | 24 ++++++++++++ doc/source/installation.rst | 12 ++++++ doc/source/readme.rst | 1 + doc/source/usage.rst | 7 ++++ setup.cfg | 23 ++++++++++++ setup.py | 28 ++++++++++++++ test-requirements.txt | 1 + tox.ini | 5 ++- 10 files changed, 176 insertions(+), 1 deletion(-) create mode 100755 doc/source/conf.py create mode 100644 doc/source/index.rst create mode 100644 doc/source/installation.rst create mode 100644 doc/source/readme.rst create mode 100644 doc/source/usage.rst create mode 100644 setup.cfg create mode 100644 setup.py diff --git a/.gitignore b/.gitignore index 33defe4..7279786 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,4 @@ .tox/ +AUTHORS +ChangeLog +doc/build/ diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100755 index 0000000..301aa6f --- /dev/null +++ b/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'ansible-role-nodepool' +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} diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..6d55f3a --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,24 @@ +.. ansible-role-nodepool documentation master file, created by + sphinx-quickstart on Tue Jul 9 22:26:36 2013. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to ansible-role-nodepool's documentation! +================================================= + +Contents: + +.. toctree:: + :maxdepth: 2 + + readme + installation + usage + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/doc/source/installation.rst b/doc/source/installation.rst new file mode 100644 index 0000000..4138d0d --- /dev/null +++ b/doc/source/installation.rst @@ -0,0 +1,12 @@ +============ +Installation +============ + +At the command line:: + + $ pip install ansible-role-nodepool + +Or, if you have virtualenvwrapper installed:: + + $ mkvirtualenv ansible-role-nodepool + $ pip install ansible-role-nodepool diff --git a/doc/source/readme.rst b/doc/source/readme.rst new file mode 100644 index 0000000..a6210d3 --- /dev/null +++ b/doc/source/readme.rst @@ -0,0 +1 @@ +.. include:: ../../README.rst diff --git a/doc/source/usage.rst b/doc/source/usage.rst new file mode 100644 index 0000000..11cd3e8 --- /dev/null +++ b/doc/source/usage.rst @@ -0,0 +1,7 @@ +======== +Usage +======== + +To use ansible-role-nodepool in a project:: + + import ansible-role-nodepool diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..e7b39d7 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,23 @@ +[metadata] +name = ansible-role-nodepool +summary = Ansible role to manage Nodepool +description-file = + README.rst +author = OpenStack +author-email = openstack-dev@lists.openstack.org +home-page = http://www.openstack.org/ +classifier = + Intended Audience :: System Administrators + License :: OSI Approved :: Apache Software License + Operating System :: POSIX :: Linux + +[build_sphinx] +source-dir = doc/source +build-dir = doc/build +all_files = 1 + +[pbr] +warnerrors = True + +[wheel] +universal = 1 diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..bb3db27 --- /dev/null +++ b/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) diff --git a/test-requirements.txt b/test-requirements.txt index 4c4414f..9ea7158 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,2 +1,3 @@ ansible-lint hacking<0.11,>=0.10 +sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3 diff --git a/tox.ini b/tox.ini index a363304..c2f82cf 100644 --- a/tox.ini +++ b/tox.ini @@ -1,6 +1,6 @@ [tox] minversion = 1.6 -envlist = ansible-lint,pep8 +envlist = ansible-lint,docs,pep8 skipsdist = True [testenv] @@ -26,6 +26,9 @@ setenv = ANSIBLE_CONFIG = {toxinidir}/tests/ansible.cfg PYTHONUNBUFFERED = 1 +[testenv:docs] +commands = python setup.py build_sphinx + [testenv:pep8] commands = flake8