From 452087a7fe9d5bf9cd8f4bdc1aec077a62b11197 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Thu, 21 May 2020 20:27:54 +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. 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: I334380cd63f408c8307fec06e8569b599d23e2f9 --- doc/requirements.txt | 6 +++--- doc/source/conf.py | 8 ++++---- releasenotes/source/conf.py | 7 +++---- 3 files changed, 10 insertions(+), 11 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index a1d8824e7..33acd8b59 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,9 +1,9 @@ # 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. -sphinx>=1.8.0,!=2.1.0 # BSD +sphinx>=2.0.0,!=2.1.0 # BSD docutils>=0.11 # OSI-Approved Open Source, Public Domain -openstackdocstheme>=1.20.0 # Apache-2.0 +openstackdocstheme>=2.2.1 # Apache-2.0 beautifulsoup4>=4.6.0 # MIT -reno>=2.5.0 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index d29b02ab6..e74947ae5 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -30,9 +30,9 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/openstacksdk' -bug_project = '972' -bug_tag = '' +openstackdocs_repo_name = 'openstack/openstacksdk' +openstackdocs_pdf_link = True +openstackdocs_use_storyboard = True html_theme = 'openstackdocs' # TODO(shade) Set this to true once the build-openstack-sphinx-docs job is @@ -64,7 +64,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' autodoc_member_order = "bysource" diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index f2f9c186e..e21e447b5 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -43,9 +43,8 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/openstacksdk' -bug_project = '760' -bug_tag = '' +openstackdocs_repo_name = 'openstack/openstacksdk' +openstackdocs_use_storyboard = True # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -98,7 +97,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 = []