diff --git a/doc/requirements.txt b/doc/requirements.txt index dd9e1498..81f812be 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -2,6 +2,6 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -openstackdocstheme>=1.11.0 -sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD +openstackdocstheme>=2.0.0 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD yasfb>=0.5.1 diff --git a/doc/source/conf.py b/doc/source/conf.py index 0438b486..ede2e0b8 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -12,7 +12,6 @@ # serve to show the default. import datetime -import subprocess import sys import os @@ -76,7 +75,7 @@ copyright = u'%s, OpenStack Cinder Team' % datetime.date.today().year # directories to ignore when looking for source files. exclude_patterns = [ '_build', - 'template.rst', + '**/template.rst', ] # The reST default role (used for this markup: `text`) to use for all documents. @@ -134,11 +133,6 @@ html_theme_options = { # pixels large. #html_favicon = None -# 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 c0dc2320..f0efa61b 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -15,7 +15,8 @@ Victoria approved specs :glob: :maxdepth: 1 - specs/victoria/* +.. any patch adding a spec should uncomment the following line: +.. specs/victoria/* Ussuri approved specs ===================== diff --git a/setup.cfg b/setup.cfg index f20fc72a..373a503c 100644 --- a/setup.cfg +++ b/setup.cfg @@ -6,6 +6,7 @@ description-file = author = OpenStack author-email = openstack-discuss@lists.openstack.org home-page = http://specs.openstack.org/openstack/cinder-specs/ +python-requires = >=3.6 classifier = Environment :: OpenStack Intended Audience :: Information Technology @@ -13,14 +14,7 @@ classifier = 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 :: Implementation :: CPython + Programming Language :: Python :: 3 :: Only Programming Language :: Python :: 3 - Programming Language :: Python :: 3.5 -[build_sphinx] -source-dir = doc/source -build-dir = doc/build -all_files = 1 - -[upload_sphinx] -upload-dir = doc/build/html + Programming Language :: Python :: 3.6 diff --git a/specs/ussuri/support-volume-local-cache.rst b/specs/ussuri/support-volume-local-cache.rst index dbee7921..92dc16bd 100644 --- a/specs/ussuri/support-volume-local-cache.rst +++ b/specs/ussuri/support-volume-local-cache.rst @@ -446,8 +446,9 @@ Documentation Impact References ========== -.. [1] https://review.opendev.org/#/c/663549/ -.. [2] https://review.opendev.org/#/c/663542/ -.. [3] https://review.opendev.org/#/c/700799/ +[1] https://review.opendev.org/#/c/663549/ +[2] https://review.opendev.org/#/c/663542/ +[3] https://review.opendev.org/#/c/700799/ + .. [4] https://review.opendev.org/#/c/689070/ .. [5] https://open-cas.github.io/ diff --git a/test-requirements.txt b/test-requirements.txt index 62220d80..861948d0 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -2,8 +2,8 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -openstackdocstheme>=1.11.0 -sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD +openstackdocstheme>=2.0.0 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD flake8 yasfb>=0.5.1 doc8>=0.6.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index 8d8bd1c0..e9ec2536 100644 --- a/tox.ini +++ b/tox.ini @@ -7,7 +7,6 @@ ignore_basepython_conflict = True [testenv] basepython = python3 usedevelop = True -install_command = pip install -U {opts} {packages} setenv = VIRTUAL_ENV={envdir} deps = -r{toxinidir}/test-requirements.txt @@ -16,7 +15,7 @@ deps = -r{toxinidir}/test-requirements.txt whitelist_externals = rm commands = rm -fr doc/build - python setup.py build_sphinx + sphinx-build -W -b html doc/source doc/build/html doc8 --ignore D001 doc/source whereto doc/source/_extra/.htaccess doc/test/redirect-tests.txt