diff options
author | Andreas Jaeger <aj@suse.com> | 2020-05-19 08:01:36 +0200 |
---|---|---|
committer | Andreas Jaeger <jaegerandi@gmail.com> | 2020-05-22 17:20:01 +0000 |
commit | 0ce00bb56943fe1e0ba9f8f3b275d030c3afcb8a (patch) | |
tree | 38ed2ea0ce1aa6827dd66e050486fffab6a3e7cc | |
parent | 952d2892e2e3dc0a3716787a75125fc467b8541a (diff) | |
download | python-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
-rw-r--r-- | doc/requirements.txt | 6 | ||||
-rw-r--r-- | doc/source/conf.py | 9 | ||||
-rw-r--r-- | lower-constraints.txt | 4 | ||||
-rw-r--r-- | releasenotes/source/conf.py | 9 |
4 files changed, 12 insertions, 16 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 = [ diff --git a/lower-constraints.txt b/lower-constraints.txt index eaa72be..28180d6 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -35,7 +35,6 @@ msgpack-python==0.4.0 munch==2.1.0 netaddr==0.7.18 netifaces==0.10.4 -openstackdocstheme==1.18.1 openstacksdk==0.11.2 os-client-config==1.28.0 os-service-types==1.2.0 @@ -64,7 +63,6 @@ python-subunit==1.0.0 python-swiftclient==3.2.0 pytz==2013.6 PyYAML==3.12 -reno==2.5.0 requests-mock==1.2.0 requests==2.14.2 requestsexceptions==1.2.0 @@ -72,8 +70,6 @@ rfc3986==0.3.1 simplejson==3.5.1 six==1.10.0 snowballstemmer==1.2.1 -Sphinx==1.6.2 -sphinxcontrib-websupport==1.0.1 stestr==2.0.0 stevedore==1.20.0 testscenarios==0.4 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 123d76a..19ff472 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -36,9 +36,10 @@ extensions = [ # 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 = '' +openstackdocs_auto_name = False # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -92,7 +93,7 @@ exclude_patterns = [] #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 = [] |