diff --git a/doc/source/conf.py b/doc/source/conf.py index e93bc052..8d1d7279 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -22,8 +22,6 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import pbr.version - # 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. @@ -66,22 +64,6 @@ role_name = 'ops' target_name = 'openstack-ansible-' + role_name title = 'OpenStack-Ansible Documentation: ' + role_name + 'role' -# The link to the browsable source code (for the left hand menu) -oslosphinx_cgit_link = ( - 'https://git.opendev.org/cgit/openstack/{}'.format(target_name) -) - -# 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. -version_info = pbr.version.VersionInfo(target_name) -# The full version, including alpha/beta/rc tags. -release = version_info.version_string_with_vcs() -# The short X.Y version. -version = version_info.canonical_version_string() - # openstackdocstheme options repository_name = 'openstack/' + target_name bug_project = project.lower() @@ -165,17 +147,13 @@ html_theme = 'openstackdocs' # 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'] +# 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 = '%Y-%m-%d %H:%M' - # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. # html_use_smartypants = True diff --git a/doc/source/index.rst b/doc/source/index.rst index a8aedfc1..308a2f7e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,3 +1,12 @@ +================================== +OpenStack-Ansible Operator Tooling +================================== + +.. toctree:: + :maxdepth: 2 + + swift_storage_mount_drives + .. include:: ../../README.rst OpenStack-Ansible Diff Generator @@ -9,3 +18,5 @@ independent roles, and the OpenStack projects it deploys. * `GitHub repository `_ * `PyPi package `_ + + diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index d4411dfe..00000000 --- a/setup.cfg +++ /dev/null @@ -1,24 +0,0 @@ -[metadata] -name = openstack-ansible-ops -summary = OpenStack-Ansible Operator Tooling -description-file = - README.rst -author = OpenStack -author-email = openstack-discuss@lists.openstack.org -home-page = https://docs.openstack.org/openstack-ansible-ops/latest/ -classifier = - Intended Audience :: Developers - Intended Audience :: System Administrators - License :: OSI Approved :: Apache Software License - Operating System :: POSIX :: Linux - -[build_sphinx] -all_files = 1 -build-dir = doc/build -source-dir = doc/source - -[pbr] -warnerrors = True - -[wheel] -universal = 1 diff --git a/setup.py b/setup.py deleted file mode 100644 index 566d8443..00000000 --- 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.0'], - pbr=True) diff --git a/tox.ini b/tox.ini index b19c3dd2..279c3d73 100644 --- a/tox.ini +++ b/tox.ini @@ -5,10 +5,8 @@ envlist = docs,linters ignore_basepython_conflict = True [testenv] -usedevelop = True +usedevelop = False basepython = python3 -install_command = - pip install -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master} {opts} {packages} commands = /usr/bin/find . -type f -name "*.pyc" -delete passenv = @@ -30,11 +28,13 @@ setenv = WORKING_DIR={toxinidir} [testenv:docs] -deps = -r{toxinidir}/doc/requirements.txt +deps = + -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master} + -r{toxinidir}/doc/requirements.txt commands= bash -c "rm -rf doc/build" doc8 doc - sphinx-build --keep-going -b html doc/source doc/build/html + sphinx-build -W --keep-going -b html doc/source doc/build/html [doc8] # Settings for doc8: