From e195c8112b78c44c9f07c5c26fb54282c2358210 Mon Sep 17 00:00:00 2001 From: melissaml Date: Fri, 22 May 2020 18:17:12 +0800 Subject: [PATCH] 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. 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. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: Ie623e7a2389c292ffc71a285f0fc2d4bb9820c3f --- api-ref/source/conf.py | 10 +++++----- doc/requirements.txt | 6 +++--- doc/source/conf.py | 10 +++++----- lower-constraints.txt | 4 ---- releasenotes/source/conf.py | 10 +++++----- 5 files changed, 18 insertions(+), 22 deletions(-) diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index a1528a0ff..5a674a23d 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -61,10 +61,10 @@ master_doc = 'index' project = u'Messaging Service API Reference' copyright = u'2010-present, OpenStack Foundation' -repository_name = 'openstack/zaqar' -bug_project = 'zaqar' -bug_tag = '' - +# openstackdocstheme options +openstackdocs_repo_name = 'openstack/zaqar' +openstackdocs_bug_project = 'zaqar' +openstackdocs_bug_tag = '' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -93,7 +93,7 @@ add_module_names = False show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # -- Options for man page output ---------------------------------------------- diff --git a/doc/requirements.txt b/doc/requirements.txt index 75935fe00..7926e0ce1 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,10 +1,10 @@ # 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.31.2 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,>=1.6.3 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD sphinxcontrib-apidoc>=0.2.0 # BSD -reno>=2.5.0 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 os-api-ref>=1.4.0 # Apache-2.0 pymongo>=3.6.0 # Apache-2.0 redis>=2.10.0 # MIT diff --git a/doc/source/conf.py b/doc/source/conf.py index 7dac0effe..eb3e4f2da 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -117,7 +117,7 @@ add_module_names = False 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 = ['zaqar.'] @@ -236,7 +236,7 @@ latex_documents = [ # If false, no module index is generated. #latex_use_modindex = True -# -- Options for openstackdocstheme ------------------------------------------- -repository_name = 'openstack/zaqar' -bug_project = 'zaqar' -bug_tag = '' +# Options for openstackdocstheme +openstackdocs_repo_name = 'openstack/zaqar' +openstackdocs_bug_project = 'zaqar' +openstackdocs_bug_tag = '' diff --git a/lower-constraints.txt b/lower-constraints.txt index 70fc4ac42..29bf8b78f 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -18,7 +18,6 @@ keystoneauth1==3.4.0 keystonemiddleware==4.17.0 mock==2.0.0 msgpack==0.5.1 -openstackdocstheme==1.31.2 os-api-ref==1.4.0 os-client-config==1.28.0 os-testr==1.0.0 @@ -50,14 +49,11 @@ python-swiftclient==3.2.0 pytz==2013.6 PyYAML==3.12 redis==3.0.0 -reno==2.5.0 requests==2.14.2 requestsexceptions==1.2.0 restructuredtext-lint==1.1.1 rfc3986==0.3.1 six==1.10.0 -sphinx===1.6.2 -sphinxcontrib-websupport==1.0.1 SQLAlchemy==1.0.10 sqlalchemy-migrate==0.11.0 stestr==2.0.0 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index f6cf02441..83519d32b 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -90,7 +90,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 = [] @@ -256,7 +256,7 @@ texinfo_documents = [ # -- Options for Internationalization output ------------------------------ locale_dirs = ['locale/'] -# -- Options for openstackdocstheme ------------------------------------------- -repository_name = 'openstack/zaqar' -bug_project = 'zaqar' -bug_tag = '' +# Options for openstackdocstheme +openstackdocs_repo_name = 'openstack/zaqar' +openstackdocs_bug_project = 'zaqar' +openstackdocs_bug_tag = ''