Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.0 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.
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.
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-Id: I80932c070dbddf9a75f64b0a4d4c614efd5a06ff
diff --git a/doc/requirements.txt b/doc/requirements.txt
index d155165..ae5457e 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -2,7 +2,7 @@
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
sphinx>=2.0.0,!=2.1.0 # BSD
-openstackdocstheme>=2.0.0 # Apache-2.0
-reno>=2.5.0 # Apache-2.0
+openstackdocstheme>=2.2.0 # Apache-2.0
+reno>=3.1.0 # Apache-2.0
sphinxcontrib-apidoc>=0.2.0 # BSD
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 12c20ec..ff8c025 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -85,9 +85,10 @@
html_theme = 'openstackdocs'
# openstackdocstheme options
-repository_name = 'openstack/patrole'
-bug_project = 'patrole'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/patrole'
+openstackdocs_pdf_link = True
+openstackdocs_bug_project = 'patrole'
+openstackdocs_bug_tag = ''
# Output file base name for HTML help builder.
htmlhelp_basename = 'patroledoc'
diff --git a/lower-constraints.txt b/lower-constraints.txt
index efbb043..a442ffc 100644
--- a/lower-constraints.txt
+++ b/lower-constraints.txt
@@ -33,7 +33,6 @@
netifaces==0.10.6
nose==1.3.7
nosexcover==1.0.10
-openstackdocstheme==2.0.0
os-client-config==1.29.0
oslo.concurrency==3.26.0
oslo.config==5.2.0
@@ -59,14 +58,11 @@
python-subunit==1.2.0
pytz==2018.3
PyYAML==3.12
-reno==2.7.0
requests==2.18.4
requestsexceptions==1.4.0
rfc3986==1.1.0
six==1.11.0
snowballstemmer==1.2.1
-Sphinx==2.0.0
-sphinxcontrib-websupport==1.0.1
stestr==2.0.0
stevedore==1.20.0
tempest==17.1.0
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index 402c686..b0ee980 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -186,10 +186,10 @@
htmlhelp_basename = 'PatroleReleaseNotesdoc'
# openstackdocstheme options
-repository_name = 'openstack/patrole'
-bug_project = 'patrole'
-bug_tag = ''
-
+openstackdocs_repo_name = 'openstack/patrole'
+openstackdocs_bug_project = 'patrole'
+openstackdocs_bug_tag = ''
+openstackdocs_auto_name = False
# -- Options for LaTeX output ---------------------------------------------