Switch to newer openstackdocstheme and reno versions

Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Disable openstackdocs_auto_version to not auto-version the documents.

Disable openstackdocs_auto_name to use 'project' variable as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

Use doc/requirements for doc requirements following PTI.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I1c0aeb590b1ce0f5ee43f9bcea51eeef1c98f057

doc/requirements.txt

@@ -0,0 +1,3 @@
+sphinx>=2.0.0,!=2.1.0 # BSD
+openstackdocstheme>=2.2.1 # Apache-2.0
+reno>=3.1.0 # Apache-2.0

doc/source/conf.py

@@ -39,9 +39,10 @@ master_doc = 'index'
 project = u'storlets'
 copyright = u'2013, OpenStack Foundation'
 # openstackdocstheme options
-repository_name = 'openstack/storlets'
-bug_project = 'storlets'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/storlets'
+openstackdocs_auto_name = False
+openstackdocs_bug_project = 'storlets'
+openstackdocs_bug_tag = ''
 # If true, '()' will be appended to :func: etc. cross-reference text.
 add_function_parentheses = True
 
@@ -50,7 +51,7 @@ add_function_parentheses = True
 add_module_names = True
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = 'native'
 
 # -- Options for HTML output --------------------------------------------------
 
@@ -61,7 +62,6 @@ html_theme = 'openstackdocs'
 # html_static_path = ['static']
 
 # Must set this variable to include year, month, day, hours, and minutes.
-html_last_updated_fmt = '%Y-%m-%d %H:%M'
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = '%sdoc' % project

releasenotes/source/conf.py

@@ -120,7 +120,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 # show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = 'native'
 
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
@@ -178,11 +178,6 @@ html_theme = 'openstackdocs'
 #
 # 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 = '%b %d, %Y'
-html_last_updated_fmt = '%Y-%m-%d %H:%M'
-
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
 #
@@ -356,6 +351,7 @@ htmlhelp_basename = 'StorletsReleaseNotesdoc'
 locale_dirs = ['locale/']
 
 # -- Options for openstackdocstheme -------------------------------------------
-repository_name = 'openstack/storlets'
-bug_project = 'storlets'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/storlets'
+openstackdocs_auto_name = False
+openstackdocs_bug_project = 'storlets'
+openstackdocs_bug_tag = ''

test-requirements.txt

@@ -9,9 +9,6 @@ coverage>=3.6
 nose
 pexpect
 python-subunit>=0.0.18
-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,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD
-openstackdocstheme>=1.11.0 # Apache-2.0
 oslotest>=1.2.0  # Apache-2.0
 stestr>=2.0.0 # Apache-2.0
 testscenarios>=0.4
@@ -21,7 +18,6 @@ python-keystoneclient
 ipython<6.0
 jupyter
 nbformat
-reno>=1.8.0  # Apache-2.0
 
 ansible
 ansible-lint

tox.ini

@@ -85,6 +85,12 @@ commands =
 
 [testenv:docs]
 basepython = python3
+deps =
+  -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
+  -r{toxinidir}/requirements.txt
+  -r{toxinidir}/test-requirements.txt
+  -r{toxinidir}/doc/requirements.txt
+  git+git://github.com/openstack/swift.git
 commands =
   sphinx-build -a -W -E -b html doc/source doc/build/html
 
@@ -128,4 +134,5 @@ passenv =
 
 [testenv:releasenotes]
 basepython = python3
+deps = {[testenv:docs]deps}
 commands = sphinx-build -a -W -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html