diff --git a/doc/networking-guide/setup.cfg b/doc/networking-guide/setup.cfg new file mode 100644 index 0000000000..2a9741e774 --- /dev/null +++ b/doc/networking-guide/setup.cfg @@ -0,0 +1,36 @@ +[metadata] +name = openstacknetworkingguide +summary = OpenStack Networking Guide +author = OpenStack +author-email = openstack-dev@lists.openstack.org +home-page = http://docs.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.6 +Programming Language :: Python :: 2.7 +Programming Language :: Python :: 3 +Programming Language :: Python :: 3.3 +Topic :: Documentation + +[global] +setup-hooks = + pbr.hooks.setup_hook + +[files] + +[build_sphinx] +all_files = 1 +build-dir = build +source-dir = source + +[wheel] +universal = 1 + +[pbr] +warnerrors = True diff --git a/doc/networking-guide/setup.py b/doc/networking-guide/setup.py new file mode 100644 index 0000000000..736375744d --- /dev/null +++ b/doc/networking-guide/setup.py @@ -0,0 +1,30 @@ +#!/usr/bin/env python +# 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'], + pbr=True) diff --git a/doc/networking-guide/conf.py b/doc/networking-guide/source/conf.py similarity index 100% rename from doc/networking-guide/conf.py rename to doc/networking-guide/source/conf.py diff --git a/doc/networking-guide/index.rst b/doc/networking-guide/source/index.rst similarity index 100% rename from doc/networking-guide/index.rst rename to doc/networking-guide/source/index.rst diff --git a/doc/networking-guide/intro_basic_networking.rst b/doc/networking-guide/source/intro_basic_networking.rst similarity index 100% rename from doc/networking-guide/intro_basic_networking.rst rename to doc/networking-guide/source/intro_basic_networking.rst diff --git a/doc/networking-guide/intro_network_namespaces.rst b/doc/networking-guide/source/intro_network_namespaces.rst similarity index 100% rename from doc/networking-guide/intro_network_namespaces.rst rename to doc/networking-guide/source/intro_network_namespaces.rst diff --git a/doc/networking-guide/intro_networking.rst b/doc/networking-guide/source/intro_networking.rst similarity index 100% rename from doc/networking-guide/intro_networking.rst rename to doc/networking-guide/source/intro_networking.rst diff --git a/doc/networking-guide/intro_networking_components.rst b/doc/networking-guide/source/intro_networking_components.rst similarity index 100% rename from doc/networking-guide/intro_networking_components.rst rename to doc/networking-guide/source/intro_networking_components.rst diff --git a/doc/networking-guide/intro_tunnel_technologies.rst b/doc/networking-guide/source/intro_tunnel_technologies.rst similarity index 100% rename from doc/networking-guide/intro_tunnel_technologies.rst rename to doc/networking-guide/source/intro_tunnel_technologies.rst diff --git a/doc/playground-user-guide/setup.cfg b/doc/playground-user-guide/setup.cfg new file mode 100644 index 0000000000..7d5ef00a5d --- /dev/null +++ b/doc/playground-user-guide/setup.cfg @@ -0,0 +1,36 @@ +[metadata] +name = openstackuserguide +summary = OpenStack User Guide +author = OpenStack +author-email = openstack-dev@lists.openstack.org +home-page = http://docs.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.6 +Programming Language :: Python :: 2.7 +Programming Language :: Python :: 3 +Programming Language :: Python :: 3.3 +Topic :: Documentation + +[global] +setup-hooks = + pbr.hooks.setup_hook + +[files] + +[build_sphinx] +all_files = 1 +build-dir = build +source-dir = source + +[wheel] +universal = 1 + +[pbr] +warnerrors = True diff --git a/doc/playground-user-guide/setup.py b/doc/playground-user-guide/setup.py new file mode 100644 index 0000000000..736375744d --- /dev/null +++ b/doc/playground-user-guide/setup.py @@ -0,0 +1,30 @@ +#!/usr/bin/env python +# 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'], + pbr=True) diff --git a/test-requirements.txt b/test-requirements.txt index 4a12239254..bb9d9bacb2 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,9 +1,12 @@ # 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. -beautifulsoup4 +pbr>=0.6,!=0.7,<1.0 + # Hacking already pins down pep8, pyflakes and flake8 hacking>=0.10.0,<0.11 + +beautifulsoup4 Jinja2>=2.6 # BSD License (3 clause) doc8 # Apache-2.0 openstack-doc-tools>=0.21.1 diff --git a/tox.ini b/tox.ini index 44a46f9646..4f5c83e7b2 100644 --- a/tox.ini +++ b/tox.ini @@ -48,7 +48,7 @@ commands = sphinx-build -W doc/playground-user-guide/source/ doc/playground-user-guide/build/html mkdir -p publish-docs/playground-user-guide/content/ rsync -a doc/playground-user-guide/build/html/ publish-docs/playground-user-guide/content/ - sphinx-build -W doc/networking-guide/ doc/networking-guide/build/html + sphinx-build -W doc/networking-guide/source doc/networking-guide/build/html mkdir -p publish-docs/networking-guide/content/ rsync -a doc/networking-guide/build/html/ publish-docs/networking-guide/content/ # Do not build DocBook XML Networking Guide @@ -57,10 +57,10 @@ commands = [testenv:docs] commands = sphinx-build -W doc/playground-user-guide/source/ doc/playground-user-guide/build/html - sphinx-build -W doc/networking-guide/ doc/networking-guide/build/html + sphinx-build -W doc/networking-guide/source doc/networking-guide/build/html [testenv:network] -commands = sphinx-build -W doc/networking-guide/ doc/networking-guide/build/html +commands = sphinx-build -W doc/networking-guide/source doc/networking-guide/build/html [testenv:publishdocs] # Prepare all documents (except www subdir) so that they can get