summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Jaeger <aj@suse.com>2020-05-18 22:08:18 +0200
committerAndreas Jaeger <aj@suse.com>2020-05-18 22:09:17 +0200
commit85ef7b7108ffe491749b52f9ffccade1e2a66164 (patch)
tree99d056ceb60266b23c8b7575d29cd3c49a1124ca
parent6d9d2e62915edcf6a5796984012ce17e1d87f1c5 (diff)
downloadpython-neutronclient-85ef7b7108ffe491749b52f9ffccade1e2a66164.tar.gz
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. Depends-On: https://review.opendev.org/728938 Change-Id: I9e1dcc5c8861ac9d800ed7425b3e3193dd13c546
-rw-r--r--doc/requirements.txt6
-rw-r--r--doc/source/conf.py7
-rw-r--r--lower-constraints.txt4
-rw-r--r--releasenotes/source/conf.py11
4 files changed, 11 insertions, 17 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt
index 8dc65ed..76ce5cd 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,6 +1,6 @@
# 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.
-openstackdocstheme>=1.32.1 # Apache-2.0
-reno>=2.5.0 # Apache-2.0
-sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
+openstackdocstheme>=2.2.0 # Apache-2.0
+reno>=3.1.0 # Apache-2.0
+sphinx>=2.0.0,!=2.1.0 # BSD
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 4b43005..e3e269e 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -13,9 +13,10 @@ extensions = [
]
# openstackdocstheme options
-repository_name = 'openstack/python-neutronclient'
-bug_project = 'python-neutronclient'
-bug_tag = 'doc'
+openstackdocs_repo_name = 'openstack/python-neutronclient'
+openstackdocs_pdf_link = True
+openstackdocs_bug_project = 'python-neutronclient'
+openstackdocs_bug_tag = 'doc'
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
diff --git a/lower-constraints.txt b/lower-constraints.txt
index 3a51d55..08d37a4 100644
--- a/lower-constraints.txt
+++ b/lower-constraints.txt
@@ -46,7 +46,6 @@ msgpack-python==0.4.0
munch==2.1.0
netaddr==0.7.18
netifaces==0.10.4
-openstackdocstheme==1.32.1
openstacksdk==0.11.2
os-client-config==1.28.0
os-service-types==1.2.0
@@ -91,7 +90,6 @@ python-openstackclient==3.12.0
python-subunit==1.0.0
pytz==2013.6
PyYAML==3.12
-reno==2.5.0
repoze.lru==0.7
requests-mock==1.2.0
requests==2.14.2
@@ -101,8 +99,6 @@ Routes==2.3.1
simplejson==3.5.1
six==1.10.0
snowballstemmer==1.2.1
-Sphinx==1.6.2
-sphinxcontrib-websupport==1.0.1
statsd==3.2.1
stestr==2.0.0
stevedore==1.20.0
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index f7ec392..5b075fe 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -43,9 +43,10 @@ extensions = [
]
# openstackdocstheme options
-repository_name = 'openstack/python-neutronclient'
-bug_project = 'python-neutronclient'
-bug_tag = 'doc'
+openstackdocs_repo_name = 'openstack/python-neutronclient'
+openstackdocs_bug_project = 'python-neutronclient'
+openstackdocs_bug_tag = 'doc'
+openstackdocs_auto_name = False
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -148,10 +149,6 @@ html_static_path = ['_static']
# directly to the root of the documentation.
# 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'
-
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True