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.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Set openstackdocs_auto_name to use 'project' 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.

Change-Id: I2421d8bcf88633c27c80d620f598365e30e55aeb

api-ref/source/conf.py

@@ -38,9 +38,11 @@ extensions = [
     'openstackdocstheme'
 ]
 
-repository_name = 'openstack/searchlight'
-bug_project = 'searchlight'
-bug_tag = 'searchlight'
+# openstackdocstheme options
+openstackdocs_repo_name = 'openstack/searchlight'
+openstackdocs_bug_project = 'searchlight'
+openstackdocs_bug_tag = ''
+openstackdocs_auto_name = False
 
 # 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

doc/requirements.txt

@@ -1,6 +1,6 @@
 # Documentation
-sphinx>=1.8.0,!=2.1.0 # BSD
-openstackdocstheme>=1.30.0 # Apache-2.0
+sphinx>=2.0.0,!=2.1.0 # BSD
+openstackdocstheme>=2.2.1 # Apache-2.0
 os-api-ref>=1.4.0 # Apache-2.0
-reno>=2.5.0 # Apache-2.0
+reno>=3.1.0 # Apache-2.0
 sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD

doc/source/conf.py

@@ -63,7 +63,6 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-project = u'Searchlight'
 copyright = u'2010-2015, OpenStack Foundation.'
 
 policy_generator_config_file = \
@@ -71,14 +70,11 @@ policy_generator_config_file = \
 sample_policy_basename = '_static/searchlight'
 
 # openstackdocstheme options
-repository_name = 'openstack/searchlight'
-bug_project = 'searchlight'
-bug_tag = 'searchlight'
+openstackdocs_repo_name = 'openstack/searchlight'
+openstackdocs_pdf_link = True
+openstackdocs_bug_project = 'searchlight'
+openstackdocs_bug_tag = ''
 
-# 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.
 from searchlight.version import version_info as searchlight_version
 # The full version, including alpha/beta/rc tags.

lower-constraints.txt

@@ -5,7 +5,6 @@ eventlet==0.18.2
 fixtures==3.0.0
 greenlet==0.4.10
 keystonemiddleware==4.17.0
-openstackdocstheme==1.18.1
 os-api-ref==1.4.0
 oslo.concurrency==3.26.0
 oslo.config==5.2.0
@@ -35,7 +34,6 @@ python-keystoneclient==3.8.0
 python-neutronclient==6.11.0
 python-novaclient==9.1.0
 python-swiftclient==3.2.0
-reno==2.5.0
 requests==2.21.0
 Routes==2.3.1
 simplejson==3.5.1

releasenotes/source/conf.py

@@ -58,9 +58,11 @@ master_doc = 'index'
 project = u'Searchlight Release Notes'
 copyright = u'2015, OpenStack Foundation'
 
-repository_name = 'openstack/searchlight'
-bug_project = 'searchlight'
-bug_tag = 'searchlight'
+# openstackdocstheme options
+openstackdocs_repo_name = 'openstack/searchlight'
+openstackdocs_bug_project = 'searchlight'
+openstackdocs_bug_tag = ''
+openstackdocs_auto_name = False
 
 # Release  notes  are version independent.
 # The short X.Y version.