diff --git a/doc/requirements.txt b/doc/requirements.txt index 2cc88ee..827758f 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,6 +1,5 @@ # 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. -sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD -sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD +sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD openstackdocstheme>=1.18.1 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index 31726cf..b26f38e 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -49,7 +49,7 @@ repository_name = 'openstack/renderspec' # Sphinx are currently 'default' and 'sphinxdoc'. # html_theme_path = ["."] # html_theme = '_theme' -html_static_path = ['static'] +# html_static_path = ['static'] # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project diff --git a/doc/source/usage.rst b/doc/source/usage.rst index 5d0dca3..e71d67f 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -285,7 +285,8 @@ With an existing yaml (and `oslo.config` epoch set to 2), this would be rendered context function `license` -************************ +************************** + The templates use `SPDX`_ license names and theses names are translated for different distros. For example, a project uses the `Apache-2.0` license:: diff --git a/setup.cfg b/setup.cfg index 0c58e9d..dfd815e 100644 --- a/setup.cfg +++ b/setup.cfg @@ -6,6 +6,7 @@ description-file = author = OpenStack author-email = openstack-discuss@lists.openstack.org home-page = https://docs.openstack.org/renderspec/latest/ +python-requires = >=3.6 classifier = Environment :: Console Environment :: OpenStack @@ -14,15 +15,13 @@ classifier = License :: OSI Approved :: Apache Software License Operating System :: POSIX :: Linux Programming Language :: Python + Programming Language :: Python :: Implementation :: CPython + Programming Language :: Python :: 3 :: Only Programming Language :: Python :: 3 Programming Language :: Python :: 3.6 Programming Language :: Python :: 3.7 Programming Language :: Python :: 3.8 -[global] -setup-hooks = - pbr.hooks.setup_hook - [entry_points] console_scripts = renderspec = renderspec:main @@ -30,14 +29,3 @@ console_scripts = [files] packages = renderspec - -[build_sphinx] -all_files = 1 -source-dir = doc/source -build-dir = doc/build - -[upload_sphinx] -upload-dir = doc/build/html - -[wheel] -universal = 1 diff --git a/setup.py b/setup.py index 566d844..cd35c3c 100644 --- a/setup.py +++ b/setup.py @@ -13,17 +13,8 @@ # 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 4ad2c42..92d9188 100644 --- a/tox.ini +++ b/tox.ini @@ -35,5 +35,6 @@ exclude = .venv,.git,.tox,dist,doc,*lib/python*,*egg,build [testenv:docs] deps = -r{toxinidir}/doc/requirements.txt commands = - python setup.py build_sphinx + sphinx-build -W -b html doc/source doc/build/html +