From 364f85e71d6938b56f8312941604970eb1f83372 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Thu, 28 May 2020 14:34:47 +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. Set openstackdocs_pdf_link to link to PDF file. Note that the link to the published document only works on docs.openstack.org where the PDF file is placed in the top-level html directory. The site-preview places the PDF in a pdf directory. 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: Iab669aaf569600fa87da8404663bbbbde0be14d6 --- doc/requirements.txt | 6 +++--- doc/source/conf.py | 7 ++++--- releasenotes/source/conf.py | 7 +++---- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 78f0002..60ba470 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,4 +1,4 @@ -sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # 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 diff --git a/doc/source/conf.py b/doc/source/conf.py index 9e2969a..12a9d48 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -41,8 +41,9 @@ project = u'os-resource-classes' copyright = u'2017, OpenStack Developers' # openstackdocstheme options -repository_name = 'openstack/os-resource-classes' -use_storyboard = True +openstackdocs_repo_name = 'openstack/os-resource-classes' +openstackdocs_pdf_link = True +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 e762e59..6a975fc 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -55,9 +55,8 @@ master_doc = 'index' copyright = u'2017, OpenStack Developers' # openstackdocstheme options -repository_name = 'openstack/os-resource-classes' -bug_project = 'nova' -bug_tag = '' +openstackdocs_repo_name = 'openstack/os-resource-classes' +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 +98,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 = []