From e1b1d7b1522ae576788672e43d89bdf5797a8bc9 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sun, 31 May 2020 20:28:42 +0200 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. Disable openstackdocs_auto_name to use 'project' variable 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. 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: Id944392d2acf01ffcb4b386434a913bfc75ccb19 --- doc/requirements.txt | 6 +++--- doc/source/conf.py | 7 ++++--- releasenotes/source/conf.py | 7 ++++--- 3 files changed, 11 insertions(+), 9 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index ddfe9c56..e847532c 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -2,8 +2,8 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -sphinx>=1.8.0,!=2.1.0 # BSD -openstackdocstheme>=1.31.2 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 # releasenotes -reno>=2.5.0 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 doc8>=0.6.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index c96d9ab4..6bd24137 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -41,8 +41,9 @@ project = u'OpenStack Helm Images' copyright = u'2018, OpenStack Developers' # openstackdocstheme options -repository_name = 'openstack/openstack-helm-images' -use_storyboard = True +openstackdocs_repo_name = 'openstack/openstack-helm-images' +openstackdocs_auto_name = False +openstackdocs_use_storyboard = True # If true, '()' will be appended to :func: etc. cross-reference text. add_function_parentheses = True @@ -52,7 +53,7 @@ add_function_parentheses = True add_module_names = True # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # -- Options for HTML output -------------------------------------------------- diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 3aeac3f7..7ab7b728 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -56,8 +56,9 @@ project = u'OpenStack Helm Images Release Notes' copyright = u'2018, OpenStack Developers' # openstackdocstheme options -repository_name = 'openstack/openstack-helm-images' -use_storyboard = True +openstackdocs_repo_name = 'openstack/openstack-helm-images' +openstackdocs_auto_name = False +openstackdocs_use_storyboard = True # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -99,7 +100,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 = []