From b77f7b9fe764f519a7dbfd9026b15db320d4aebd Mon Sep 17 00:00:00 2001 From: melissaml Date: Fri, 22 May 2020 17:31:47 +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. 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: Ic5ff4981e5ed09885fd2aaad7508d58d2b2cccc7 --- api-ref/source/conf.py | 9 +++++---- doc/source/conf.py | 13 +++++-------- lower-constraints.txt | 4 ++-- releasenotes/source/conf.py | 10 +++++----- test-requirements.txt | 4 ++-- 5 files changed, 19 insertions(+), 21 deletions(-) diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index 665c90447f..19e35cfc2e 100755 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -36,9 +36,10 @@ html_theme = 'openstackdocs' html_theme_options = { "sidebar_mode": "toc", } -repository_name = 'openstack/trove' -bug_project = 'trove' -bug_tag = '' +openstackdocs_repo_name = 'openstack/trove' +openstack_auto_name = False +openstackdocs_bug_project = 'trove' +openstackdocs_bug_tag = '' # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the @@ -93,7 +94,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/source/conf.py b/doc/source/conf.py index 346fe4bbef..7f7fa9a410 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -19,9 +19,10 @@ extensions = ['sphinx.ext.todo', 'stevedore.sphinxext'] # openstackdocstheme options -repository_name = 'openstack/trove' -bug_project = 'trove' -bug_tag = '' +openstackdocs_repo_name = 'openstack/trove' +openstackdocs_bug_project = 'trove' +openstack_auto_name = False +openstackdocs_bug_tag = '' html_theme = 'openstackdocs' # Add any paths that contain templates here, relative to this directory. @@ -69,7 +70,7 @@ add_module_names = True #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 = ['trove.'] @@ -114,10 +115,6 @@ modindex_common_prefix = ['trove.'] # so a file named "default.css" will overwrite the builtin "default.css". # html_static_path = ['_static'] -# 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 diff --git a/lower-constraints.txt b/lower-constraints.txt index 81d3320151..78d4ed37cb 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -67,7 +67,7 @@ networkx==1.11 nose==1.3.7 nosexcover==1.0.10 openstack.nose-plugin==0.7 -openstackdocstheme==1.32.1 +openstackdocstheme==2.2.1 openstacksdk==0.12.0 os-api-ref==1.4.0 os-client-config==1.29.0 @@ -128,7 +128,7 @@ python-troveclient==2.2.0 pytz==2018.3 PyYAML==3.12 redis==2.10.0 -reno==2.5.0 +reno==3.1.0 repoze.lru==0.7 requests==2.18.4 requestsexceptions==1.4.0 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 5e84795051..25398e444c 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -43,10 +43,10 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/trove' -bug_project = 'trove' -bug_tag = '' -html_last_updated_fmt = '%Y-%m-%d %H:%M' +openstackdocs_repo_name = 'openstack/trove' +openstack_auto_name = False +openstackdocs_bug_project = 'trove' +openstackdocs_bug_tag = '' html_theme = 'openstackdocs' # Add any paths that contain templates here, relative to this directory. @@ -103,7 +103,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 = [] diff --git a/test-requirements.txt b/test-requirements.txt index b86d58eaff..7c558ef744 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -25,6 +25,6 @@ pylint==1.9.2 # GPLv2 oslotest>=3.2.0 # Apache-2.0 tenacity>=4.9.0 # Apache-2.0 # Docs building -openstackdocstheme>=1.32.1 # Apache-2.0 +openstackdocstheme>=2.2.1 # Apache-2.0 os-api-ref>=1.4.0 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 +reno>=3.1.0 # Apache-2.0