From 800df7c95a3df66aba5a0c8b9aa2dc6ebd0624ef Mon Sep 17 00:00:00 2001 From: Sean Handley Date: Fri, 29 Sep 2017 09:51:04 +0100 Subject: [PATCH] Remove a load of autogenerated cruft that we don't need. Change-Id: Id1f67b8fa16b90b4cfbf6a6320e9718e64d8fe8c --- .coveragerc | 6 - .mailmap | 3 - PublicCloudWG/__init__.py | 19 -- PublicCloudWG/tests/__init__.py | 0 PublicCloudWG/tests/base.py | 23 -- PublicCloudWG/tests/test_PublicCloudWG.py | 28 -- babel.cfg | 2 - doc/source/admin/index.rst | 5 - doc/source/cli/index.rst | 5 - doc/source/conf.py | 1 + doc/source/configuration/index.rst | 5 - doc/source/contributor/contributing.rst | 4 - doc/source/contributor/index.rst | 9 - doc/source/index.rst | 8 - doc/source/install/common_configure.rst | 10 - doc/source/install/common_prerequisites.rst | 75 ------ doc/source/install/get_started.rst | 9 - doc/source/install/index.rst | 17 -- doc/source/install/install-obs.rst | 34 --- doc/source/install/install-rdo.rst | 33 --- doc/source/install/install-ubuntu.rst | 31 --- doc/source/install/install.rst | 20 -- doc/source/install/next-steps.rst | 9 - doc/source/install/verify.rst | 24 -- doc/source/library/index.rst | 7 - doc/source/reference/index.rst | 5 - doc/source/user/index.rst | 5 - releasenotes/notes/.placeholder | 0 releasenotes/source/_static/.placeholder | 0 releasenotes/source/_templates/.placeholder | 0 releasenotes/source/conf.py | 280 -------------------- releasenotes/source/index.rst | 8 - releasenotes/source/unreleased.rst | 5 - requirements.txt | 12 +- setup.cfg | 39 +-- test-requirements.txt | 6 +- tox.ini | 39 +-- 37 files changed, 31 insertions(+), 755 deletions(-) delete mode 100644 .coveragerc delete mode 100644 .mailmap delete mode 100644 PublicCloudWG/__init__.py delete mode 100644 PublicCloudWG/tests/__init__.py delete mode 100644 PublicCloudWG/tests/base.py delete mode 100644 PublicCloudWG/tests/test_PublicCloudWG.py delete mode 100644 babel.cfg delete mode 100644 doc/source/admin/index.rst delete mode 100644 doc/source/cli/index.rst delete mode 100644 doc/source/configuration/index.rst delete mode 100644 doc/source/contributor/contributing.rst delete mode 100644 doc/source/contributor/index.rst delete mode 100644 doc/source/install/common_configure.rst delete mode 100644 doc/source/install/common_prerequisites.rst delete mode 100644 doc/source/install/get_started.rst delete mode 100644 doc/source/install/index.rst delete mode 100644 doc/source/install/install-obs.rst delete mode 100644 doc/source/install/install-rdo.rst delete mode 100644 doc/source/install/install-ubuntu.rst delete mode 100644 doc/source/install/install.rst delete mode 100644 doc/source/install/next-steps.rst delete mode 100644 doc/source/install/verify.rst delete mode 100644 doc/source/library/index.rst delete mode 100644 doc/source/reference/index.rst delete mode 100644 doc/source/user/index.rst delete mode 100644 releasenotes/notes/.placeholder delete mode 100644 releasenotes/source/_static/.placeholder delete mode 100644 releasenotes/source/_templates/.placeholder delete mode 100644 releasenotes/source/conf.py delete mode 100644 releasenotes/source/index.rst delete mode 100644 releasenotes/source/unreleased.rst diff --git a/.coveragerc b/.coveragerc deleted file mode 100644 index 986c70b..0000000 --- a/.coveragerc +++ /dev/null @@ -1,6 +0,0 @@ -[run] -branch = True -source = PublicCloudWG - -[report] -ignore_errors = True diff --git a/.mailmap b/.mailmap deleted file mode 100644 index 516ae6f..0000000 --- a/.mailmap +++ /dev/null @@ -1,3 +0,0 @@ -# Format is: -# -# diff --git a/PublicCloudWG/__init__.py b/PublicCloudWG/__init__.py deleted file mode 100644 index d5855d0..0000000 --- a/PublicCloudWG/__init__.py +++ /dev/null @@ -1,19 +0,0 @@ -# -*- 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 pbr.version - - -__version__ = pbr.version.VersionInfo( - 'publiccloud-wg').version_string() diff --git a/PublicCloudWG/tests/__init__.py b/PublicCloudWG/tests/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/PublicCloudWG/tests/base.py b/PublicCloudWG/tests/base.py deleted file mode 100644 index 1c30cdb..0000000 --- a/PublicCloudWG/tests/base.py +++ /dev/null @@ -1,23 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright 2010-2011 OpenStack Foundation -# 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. - -from oslotest import base - - -class TestCase(base.BaseTestCase): - - """Test case base class for all unit tests.""" diff --git a/PublicCloudWG/tests/test_PublicCloudWG.py b/PublicCloudWG/tests/test_PublicCloudWG.py deleted file mode 100644 index 18e3f4f..0000000 --- a/PublicCloudWG/tests/test_PublicCloudWG.py +++ /dev/null @@ -1,28 +0,0 @@ -# -*- 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. - -""" -test_PublicCloudWG ----------------------------------- - -Tests for `PublicCloudWG` module. -""" - -from PublicCloudWG.tests import base - - -class TestPubliccloudwg(base.TestCase): - - def test_something(self): - pass diff --git a/babel.cfg b/babel.cfg deleted file mode 100644 index 15cd6cb..0000000 --- a/babel.cfg +++ /dev/null @@ -1,2 +0,0 @@ -[python: **.py] - diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst deleted file mode 100644 index 2e9dc40..0000000 --- a/doc/source/admin/index.rst +++ /dev/null @@ -1,5 +0,0 @@ -==================== -Administrators guide -==================== - -Administrators guide of publiccloud-wg. diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst deleted file mode 100644 index ee80fac..0000000 --- a/doc/source/cli/index.rst +++ /dev/null @@ -1,5 +0,0 @@ -================================ -Command line interface reference -================================ - -CLI reference of publiccloud-wg. diff --git a/doc/source/conf.py b/doc/source/conf.py index e8b18d8..d8200ca 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -63,6 +63,7 @@ pygments_style = 'sphinx' # html_theme = '_theme' # html_static_path = ['static'] html_theme = 'openstackdocs' +# html_theme = 'nature' # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst deleted file mode 100644 index 12901da..0000000 --- a/doc/source/configuration/index.rst +++ /dev/null @@ -1,5 +0,0 @@ -============= -Configuration -============= - -Configuration of publiccloud-wg. diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst deleted file mode 100644 index 2aa0707..0000000 --- a/doc/source/contributor/contributing.rst +++ /dev/null @@ -1,4 +0,0 @@ -============ -Contributing -============ -.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst deleted file mode 100644 index 036e449..0000000 --- a/doc/source/contributor/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -=========================== - Contributor Documentation -=========================== - -.. toctree:: - :maxdepth: 2 - - contributing - diff --git a/doc/source/index.rst b/doc/source/index.rst index 44fc4b7..aa7d944 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -13,14 +13,6 @@ Contents: :maxdepth: 2 readme - install/index - library/index - contributor/index - configuration/index - cli/index - user/index - admin/index - reference/index Indices and tables ================== diff --git a/doc/source/install/common_configure.rst b/doc/source/install/common_configure.rst deleted file mode 100644 index 37b0dc9..0000000 --- a/doc/source/install/common_configure.rst +++ /dev/null @@ -1,10 +0,0 @@ -2. Edit the ``/etc/PublicCloudWG/PublicCloudWG.conf`` file and complete the following - actions: - - * In the ``[database]`` section, configure database access: - - .. code-block:: ini - - [database] - ... - connection = mysql+pymysql://PublicCloudWG:PUBLICCLOUDWG_DBPASS@controller/PublicCloudWG diff --git a/doc/source/install/common_prerequisites.rst b/doc/source/install/common_prerequisites.rst deleted file mode 100644 index 411e476..0000000 --- a/doc/source/install/common_prerequisites.rst +++ /dev/null @@ -1,75 +0,0 @@ -Prerequisites -------------- - -Before you install and configure the replace with the service it implements service, -you must create a database, service credentials, and API endpoints. - -#. To create the database, complete these steps: - - * Use the database access client to connect to the database - server as the ``root`` user: - - .. code-block:: console - - $ mysql -u root -p - - * Create the ``PublicCloudWG`` database: - - .. code-block:: none - - CREATE DATABASE PublicCloudWG; - - * Grant proper access to the ``PublicCloudWG`` database: - - .. code-block:: none - - GRANT ALL PRIVILEGES ON PublicCloudWG.* TO 'PublicCloudWG'@'localhost' \ - IDENTIFIED BY 'PUBLICCLOUDWG_DBPASS'; - GRANT ALL PRIVILEGES ON PublicCloudWG.* TO 'PublicCloudWG'@'%' \ - IDENTIFIED BY 'PUBLICCLOUDWG_DBPASS'; - - Replace ``PUBLICCLOUDWG_DBPASS`` with a suitable password. - - * Exit the database access client. - - .. code-block:: none - - exit; - -#. Source the ``admin`` credentials to gain access to - admin-only CLI commands: - - .. code-block:: console - - $ . admin-openrc - -#. To create the service credentials, complete these steps: - - * Create the ``PublicCloudWG`` user: - - .. code-block:: console - - $ openstack user create --domain default --password-prompt PublicCloudWG - - * Add the ``admin`` role to the ``PublicCloudWG`` user: - - .. code-block:: console - - $ openstack role add --project service --user PublicCloudWG admin - - * Create the PublicCloudWG service entities: - - .. code-block:: console - - $ openstack service create --name PublicCloudWG --description "replace with the service it implements" replace with the service it implements - -#. Create the replace with the service it implements service API endpoints: - - .. code-block:: console - - $ openstack endpoint create --region RegionOne \ - replace with the service it implements public http://controller:XXXX/vY/%\(tenant_id\)s - $ openstack endpoint create --region RegionOne \ - replace with the service it implements internal http://controller:XXXX/vY/%\(tenant_id\)s - $ openstack endpoint create --region RegionOne \ - replace with the service it implements admin http://controller:XXXX/vY/%\(tenant_id\)s diff --git a/doc/source/install/get_started.rst b/doc/source/install/get_started.rst deleted file mode 100644 index fd355b9..0000000 --- a/doc/source/install/get_started.rst +++ /dev/null @@ -1,9 +0,0 @@ -======================================================= -replace with the service it implements service overview -======================================================= -The replace with the service it implements service provides... - -The replace with the service it implements service consists of the following components: - -``PublicCloudWG-api`` service - Accepts and responds to end user compute API calls... diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst deleted file mode 100644 index dc65a42..0000000 --- a/doc/source/install/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -================================================================= -replace with the service it implements service installation guide -================================================================= - -.. toctree:: - :maxdepth: 2 - - get_started.rst - install.rst - verify.rst - next-steps.rst - -The replace with the service it implements service (PublicCloudWG) provides... - -This chapter assumes a working setup of OpenStack following the -`OpenStack Installation Tutorial -`_. diff --git a/doc/source/install/install-obs.rst b/doc/source/install/install-obs.rst deleted file mode 100644 index 4321458..0000000 --- a/doc/source/install/install-obs.rst +++ /dev/null @@ -1,34 +0,0 @@ -.. _install-obs: - - -Install and configure for openSUSE and SUSE Linux Enterprise -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This section describes how to install and configure the replace with the service it implements service -for openSUSE Leap 42.1 and SUSE Linux Enterprise Server 12 SP1. - -.. include:: common_prerequisites.rst - -Install and configure components --------------------------------- - -#. Install the packages: - - .. code-block:: console - - # zypper --quiet --non-interactive install - -.. include:: common_configure.rst - - -Finalize installation ---------------------- - -Start the replace with the service it implements services and configure them to start when -the system boots: - -.. code-block:: console - - # systemctl enable openstack-PublicCloudWG-api.service - - # systemctl start openstack-PublicCloudWG-api.service diff --git a/doc/source/install/install-rdo.rst b/doc/source/install/install-rdo.rst deleted file mode 100644 index 585a6fc..0000000 --- a/doc/source/install/install-rdo.rst +++ /dev/null @@ -1,33 +0,0 @@ -.. _install-rdo: - -Install and configure for Red Hat Enterprise Linux and CentOS -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - -This section describes how to install and configure the replace with the service it implements service -for Red Hat Enterprise Linux 7 and CentOS 7. - -.. include:: common_prerequisites.rst - -Install and configure components --------------------------------- - -#. Install the packages: - - .. code-block:: console - - # yum install - -.. include:: common_configure.rst - -Finalize installation ---------------------- - -Start the replace with the service it implements services and configure them to start when -the system boots: - -.. code-block:: console - - # systemctl enable openstack-PublicCloudWG-api.service - - # systemctl start openstack-PublicCloudWG-api.service diff --git a/doc/source/install/install-ubuntu.rst b/doc/source/install/install-ubuntu.rst deleted file mode 100644 index 9ff408c..0000000 --- a/doc/source/install/install-ubuntu.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. _install-ubuntu: - -Install and configure for Ubuntu -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This section describes how to install and configure the replace with the service it implements -service for Ubuntu 14.04 (LTS). - -.. include:: common_prerequisites.rst - -Install and configure components --------------------------------- - -#. Install the packages: - - .. code-block:: console - - # apt-get update - - # apt-get install - -.. include:: common_configure.rst - -Finalize installation ---------------------- - -Restart the replace with the service it implements services: - -.. code-block:: console - - # service openstack-PublicCloudWG-api restart diff --git a/doc/source/install/install.rst b/doc/source/install/install.rst deleted file mode 100644 index fa39d23..0000000 --- a/doc/source/install/install.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. _install: - -Install and configure -~~~~~~~~~~~~~~~~~~~~~ - -This section describes how to install and configure the -replace with the service it implements service, code-named PublicCloudWG, on the controller node. - -This section assumes that you already have a working OpenStack -environment with at least the following components installed: -.. (add the appropriate services here and further notes) - -Note that installation and configuration vary by distribution. - -.. toctree:: - :maxdepth: 2 - - install-obs.rst - install-rdo.rst - install-ubuntu.rst diff --git a/doc/source/install/next-steps.rst b/doc/source/install/next-steps.rst deleted file mode 100644 index 90fa1db..0000000 --- a/doc/source/install/next-steps.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. _next-steps: - -Next steps -~~~~~~~~~~ - -Your OpenStack environment now includes the PublicCloudWG service. - -To add additional services, see -https://docs.openstack.org/project-install-guide/ocata/. diff --git a/doc/source/install/verify.rst b/doc/source/install/verify.rst deleted file mode 100644 index dbbb21b..0000000 --- a/doc/source/install/verify.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. _verify: - -Verify operation -~~~~~~~~~~~~~~~~ - -Verify operation of the replace with the service it implements service. - -.. note:: - - Perform these commands on the controller node. - -#. Source the ``admin`` project credentials to gain access to - admin-only CLI commands: - - .. code-block:: console - - $ . admin-openrc - -#. List service components to verify successful launch and registration - of each process: - - .. code-block:: console - - $ openstack replace with the service it implements service list diff --git a/doc/source/library/index.rst b/doc/source/library/index.rst deleted file mode 100644 index 9a44663..0000000 --- a/doc/source/library/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -======== -Usage -======== - -To use publiccloud-wg in a project:: - - import PublicCloudWG diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst deleted file mode 100644 index 3e9a59b..0000000 --- a/doc/source/reference/index.rst +++ /dev/null @@ -1,5 +0,0 @@ -========== -References -========== - -References of publiccloud-wg. diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst deleted file mode 100644 index 5df7a37..0000000 --- a/doc/source/user/index.rst +++ /dev/null @@ -1,5 +0,0 @@ -=========== -Users guide -=========== - -Users guide of publiccloud-wg. diff --git a/releasenotes/notes/.placeholder b/releasenotes/notes/.placeholder deleted file mode 100644 index e69de29..0000000 diff --git a/releasenotes/source/_static/.placeholder b/releasenotes/source/_static/.placeholder deleted file mode 100644 index e69de29..0000000 diff --git a/releasenotes/source/_templates/.placeholder b/releasenotes/source/_templates/.placeholder deleted file mode 100644 index e69de29..0000000 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py deleted file mode 100644 index 1841f63..0000000 --- a/releasenotes/source/conf.py +++ /dev/null @@ -1,280 +0,0 @@ -# -*- 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. - -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -# needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - 'openstackdocstheme', - 'reno.sphinxext', -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'PublicCloudWG Release Notes' -copyright = u'2017, OpenStack Developers' - -# openstackdocstheme options -repository_name = 'publiccloud-wg-core/publiccloud-wg' -bug_project = 'openstack-publiccloud-wg' -bug_tag = '' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -# The full version, including alpha/beta/rc tags. -release = '' -# The short X.Y version. -version = '' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = [] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# default_role = None - -# 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 - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'openstackdocs' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -# html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -# html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -# html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -# html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is generated. -# html_domain_indices = True - -# If false, no index is generated. -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = 'PublicCloudWGReleaseNotesdoc' - - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # 'preamble': '', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ('index', 'PublicCloudWGReleaseNotes.tex', - u'PublicCloudWG Release Notes Documentation', - u'OpenStack Foundation', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'PublicCloudWGrereleasenotes', - u'PublicCloudWG Release Notes Documentation', - [u'OpenStack Foundation'], 1) -] - -# If true, show URL addresses after external links. -# man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ('index', 'PublicCloudWG ReleaseNotes', - u'PublicCloudWG Release Notes Documentation', - u'OpenStack Foundation', 'PublicCloudWGReleaseNotes', - 'One line description of project.', - 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -# texinfo_appendices = [] - -# If false, no module index is generated. -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False - -# -- Options for Internationalization output ------------------------------ -locale_dirs = ['locale/'] diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst deleted file mode 100644 index 3b2cbb4..0000000 --- a/releasenotes/source/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -============================================ - PublicCloudWG Release Notes -============================================ - -.. toctree:: - :maxdepth: 1 - - unreleased diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst deleted file mode 100644 index cd22aab..0000000 --- a/releasenotes/source/unreleased.rst +++ /dev/null @@ -1,5 +0,0 @@ -============================== - Current Series Release Notes -============================== - -.. release-notes:: diff --git a/requirements.txt b/requirements.txt index 1d18dd3..4bf8d7b 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,4 +2,14 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -pbr>=2.0 # Apache-2.0 +hacking>=0.12.0,<0.13 # Apache-2.0 + +coverage>=4.0,!=4.4 # Apache-2.0 +python-subunit>=0.0.18 # Apache-2.0/BSD +sphinx>=1.6.2 # BSD +oslotest>=1.10.0 # Apache-2.0 +testrepository>=0.0.18 # Apache-2.0/BSD +testtools>=1.4.0 # MIT +openstackdocstheme>=1.11.0 # Apache-2.0 +# releasenotes +reno>=1.8.0 # Apache-2.0 \ No newline at end of file diff --git a/setup.cfg b/setup.cfg index a58cbc3..1a9b0a0 100644 --- a/setup.cfg +++ b/setup.cfg @@ -7,41 +7,20 @@ 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 + Intended Audience :: Developers 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 - -[files] -packages = - PublicCloudWG [build_sphinx] -all-files = 1 -warning-is-error = 1 -source-dir = doc/source +all_files = 1 build-dir = doc/build +source-dir = doc/source + +[pbr] +warnerrors = True + +[wheel] +universal = 1 [upload_sphinx] upload-dir = doc/build/html - -[compile_catalog] -directory = PublicCloudWG/locale -domain = PublicCloudWG - -[update_catalog] -domain = PublicCloudWG -output_dir = PublicCloudWG/locale -input_file = PublicCloudWG/locale/PublicCloudWG.pot - -[extract_messages] -keywords = _ gettext ngettext l_ lazy_gettext -mapping_file = babel.cfg -output_file = PublicCloudWG/locale/PublicCloudWG.pot diff --git a/test-requirements.txt b/test-requirements.txt index f559c0e..6fc0397 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,7 +1,3 @@ -# The order of packages is significant, because pip processes them in the order -# of appearance. Changing the order has an impact on the overall integration -# process, which may cause wedges in the gate later. - hacking>=0.12.0,<0.13 # Apache-2.0 coverage>=4.0,!=4.4 # Apache-2.0 @@ -12,4 +8,4 @@ testrepository>=0.0.18 # Apache-2.0/BSD testtools>=1.4.0 # MIT openstackdocstheme>=1.11.0 # Apache-2.0 # releasenotes -reno>=1.8.0 # Apache-2.0 +reno>=1.8.0 # Apache-2.0 \ No newline at end of file diff --git a/tox.ini b/tox.ini index c888992..a6747f6 100644 --- a/tox.ini +++ b/tox.ini @@ -1,40 +1,19 @@ [tox] -minversion = 2.0 -envlist = py34,py27,pypy,pep8 +# Hold back to 1.4, since that's what's in Fedora 20 repos +# and we don't need anything newer for nova-specs tests +minversion = 1.4 +envlist = docs,py27 skipsdist = True [testenv] usedevelop = True -install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages} -setenv = - VIRTUAL_ENV={envdir} - PYTHONWARNINGS=default::DeprecationWarning -deps = -r{toxinidir}/test-requirements.txt -commands = python setup.py test --slowest --testr-args='{posargs}' - -[testenv:pep8] -commands = flake8 {posargs} +setenv = VIRTUAL_ENV={envdir} +install_command = pip install -U {opts} {packages} +deps = -r{toxinidir}/requirements.txt +commands = python setup.py testr --slowest --testr-args='{posargs}' [testenv:venv] commands = {posargs} -[testenv:cover] -commands = python setup.py test --coverage --testr-args='{posargs}' - [testenv:docs] -commands = python setup.py build_sphinx - -[testenv:releasenotes] -commands = - sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html - -[testenv:debug] -commands = oslo_debug_helper {posargs} - -[flake8] -# E123, E125 skipped as they are invalid PEP-8. - -show-source = True -ignore = E123,E125 -builtins = _ -exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build +commands = python setup.py build_sphinx \ No newline at end of file