diff --git a/README.rst b/README.rst index 3c6dcfe..f2d3b0d 100644 --- a/README.rst +++ b/README.rst @@ -1,19 +1,22 @@ -=============================== -devstack-plugin-libvirt-qemu -=============================== +============================ +DevStack Libvirt QEMU Plugin +============================ -OpenStack Boilerplate contains all the boilerplate you need to create an OpenStack package. +This project is a plugin for DevStack, which is a set of scripts and utilities +to quickly deploy an OpenStack cloud. -Please fill here a long description which must be at least 3 lines wrapped on -80 cols, so that distribution package maintainers can use it in their packages. -Note that this is a hard requirement. +This DevStack plugin provides the ability to download and compile libvirt and +QEMU from source. It also gives the ability to set an specific Git commit to be +used in the compilation + +For more information, refer to the `DevStack Documentation`__, and the +`libvirt`__ and `QEMU`__ docs. * Free software: Apache license * Documentation: http://docs.openstack.org/developer/devstack-plugin-libvirt-qemu * Source: http://git.openstack.org/cgit/devstack-plugin-libvirt-qemu/devstack-plugin-libvirt-qemu * Bugs: http://bugs.launchpad.net/devstack-plugin-libvirt-qemu -Features --------- - -* TODO +__ https://docs.openstack.org/devstack/latest/plugins.html +__ https://libvirt.org/ +__ http://www.qemu.org/ 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/conf.py b/doc/source/conf.py index 789791b..b79c802 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -22,8 +22,7 @@ sys.path.insert(0, os.path.abspath('../..')) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'sphinx.ext.autodoc', - #'sphinx.ext.intersphinx', - 'oslosphinx' + 'openstackdocstheme', ] # autodoc generation is a bit aggressive and a nuisance when doing heavy diff --git a/readme.md b/readme.md deleted file mode 100644 index bd7d680..0000000 --- a/readme.md +++ /dev/null @@ -1,25 +0,0 @@ -============================ -devstack-plugin-libvirt-qemu -============================ - -This project is a set of scripts to be executed along with DevStack. DevStack -is a set of scripts and utilities to quickly deploy an OpenStack cloud. - -This DevStack plugin provides the ability to download from the source and -compile libvirt and QEMU. Also gives the ability to set an specific git commit -to be used in the compilation - -A Collection of Agents and Drivers to support managing DPDK accelerated Open -vSwitch with neutron. - -* Free software: Apache license -* Source: https://github.com/openstack/devstack-plugin-libvirt-qemu - - -The following are links to background information that provide additional -insight into the related programs used in this project: - -* libvirt - - Official libvirt website: https://github.com/openstack/devstack-plugin-libvirt-qemu -* Qemu: - - Official QEMU website: http://www.qemu.org/ diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index 1d18dd3..0000000 --- a/requirements.txt +++ /dev/null @@ -1,5 +0,0 @@ -# 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. - -pbr>=2.0 # Apache-2.0 diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index 0cf48e5..0000000 --- a/setup.cfg +++ /dev/null @@ -1,47 +0,0 @@ -[metadata] -name = devstack-plugin-libvirt-qemu -summary = OpenStack Boilerplate contains all the boilerplate you need to create an OpenStack package. -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 - -[files] -packages = - devstack_plugin_libvirt_qemu - -[build_sphinx] -all-files = 1 -warning-is-error = 1 -source-dir = doc/source -build-dir = doc/build - -[upload_sphinx] -upload-dir = doc/build/html - -[compile_catalog] -directory = devstack_plugin_libvirt_qemu/locale -domain = devstack_plugin_libvirt_qemu - -[update_catalog] -domain = devstack_plugin_libvirt_qemu -output_dir = devstack_plugin_libvirt_qemu/locale -input_file = devstack_plugin_libvirt_qemu/locale/devstack_plugin_libvirt_qemu.pot - -[extract_messages] -keywords = _ gettext ngettext l_ lazy_gettext -mapping_file = babel.cfg -output_file = devstack_plugin_libvirt_qemu/locale/devstack_plugin_libvirt_qemu.pot diff --git a/setup.py b/setup.py deleted file mode 100644 index 3887303..0000000 --- a/setup.py +++ /dev/null @@ -1,29 +0,0 @@ -# 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. - -# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT -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>=2.0'], - pbr=True) diff --git a/test-requirements.txt b/test-requirements.txt index 08b0ad2..97f33e9 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -2,15 +2,8 @@ # 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 # Apache-2.0 -python-subunit>=0.0.18 # Apache-2.0/BSD -sphinx>=1.5.1,<1.6 # BSD -oslosphinx>=4.7.0 # Apache-2.0 -oslotest>=1.10.0 # Apache-2.0 -testrepository>=0.0.18 # Apache-2.0/BSD -testtools>=1.4.0 # MIT +openstackdocstheme>=1.16.0 # Apache-2.0 +sphinx>=1.6.2 # BSD # releasenotes -reno>=1.8.0 # Apache-2.0 +reno>=2.5.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index 21a8e52..0bb9bce 100644 --- a/tox.ini +++ b/tox.ini @@ -4,13 +4,10 @@ envlist = bashate 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:bashate] # if you want to test out some changes you have made to bashate @@ -39,11 +36,9 @@ commands = bash -c "find {toxinidir} \ -print0 | xargs -0 bashate -v -iE006 -eE005,E042" [testenv:docs] -commands = python setup.py build_sphinx +commands = + sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html [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}