From 1a81faf86a7cc644c761dcf43ed19e6c2db0033d Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Fri, 15 May 2020 20:12:15 +0200 Subject: 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. openstackdocstheme renames some variables, so follow the renames. A couple of variables are also not needed anymore, remove them. Set openstackdocs_auto_name to use project as name. 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. 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: I2cc022495b162bec1424ec69611acb879900c005 --- releasenotes/source/conf.py | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) (limited to 'releasenotes') diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index cff4496..58ed268 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -56,6 +56,7 @@ master_doc = 'index' # General information about the project. project = u'Cinder Client Release Notes' +openstackdocs_auto_name = False copyright = u'2015, Cinder Developers' # Release notes are version independent, no need to set version and release @@ -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 = [] @@ -141,11 +142,6 @@ html_static_path = ['_static'] # directly to the root of the documentation. # html_extra_path = [] -# 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' -html_last_updated_fmt = '%Y-%m-%d %H:%M' - # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. # html_use_smartypants = True @@ -273,6 +269,6 @@ texinfo_documents = [ locale_dirs = ['locale/'] # -- Options for openstackdocstheme ------------------------------------------- -repository_name = 'openstack/python-cinderclient' -bug_project = 'cinderclient' -bug_tag = '' +openstackdocs_repo_name = 'openstack/python-cinderclient' +openstackdocs_bug_project = 'cinderclient' +openstackdocs_bug_tag = '' -- cgit v1.2.1