summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAndreas Jaeger <aj@suse.com>2020-05-19 08:01:36 +0200
committerAndreas Jaeger <jaegerandi@gmail.com>2020-05-22 17:20:01 +0000
commit0ce00bb56943fe1e0ba9f8f3b275d030c3afcb8a (patch)
tree38ed2ea0ce1aa6827dd66e050486fffab6a3e7cc /doc
parent952d2892e2e3dc0a3716787a75125fc467b8541a (diff)
downloadpython-troveclient-0ce00bb56943fe1e0ba9f8f3b275d030c3afcb8a.tar.gz
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_auto_name to use 'project' as name. 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 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. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: Ib5706db978edfdddb88230ee81a563c7976f238a
Diffstat (limited to 'doc')
-rw-r--r--doc/requirements.txt6
-rw-r--r--doc/source/conf.py9
2 files changed, 7 insertions, 8 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt
index 0c9dba3..bba582b 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,8 +1,8 @@
# 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.
-sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
+sphinx>=2.0.0,!=2.1.0 # BSD
sphinxcontrib-apidoc>=0.2.0 # BSD
-reno>=2.5.0 # Apache-2.0
-openstackdocstheme>=1.18.1 # Apache-2.0
+reno>=3.1.0 # Apache-2.0
+openstackdocstheme>=2.2.1 # Apache-2.0
httplib2>=0.9.1 # MIT
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 97e1bc9..5443c2d 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -45,9 +45,9 @@ apidoc_excluded_paths = [
apidoc_separate_modules = True
# openstackdocstheme options
-repository_name = 'openstack/python-troveclient'
-bug_project = 'python-troveclient'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/python-troveclient'
+openstackdocs_bug_project = 'python-troveclient'
+openstackdocs_bug_tag = ''
html_theme = 'openstackdocs'
templates_path = ['_templates']
@@ -56,12 +56,11 @@ source_suffix = '.rst'
master_doc = 'index'
-project = u'python-troveclient'
copyright = u'2014, OpenStack Foundation'
exclude_trees = []
-pygments_style = 'sphinx'
+pygments_style = 'native'
htmlhelp_basename = 'python-troveclientdoc'
latex_documents = [