From d249b802beba82594b0b8e5b1cca3a282577ea29 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Thu, 21 May 2020 20:18:09 +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: I882ab18020ee8a15a3204e72d1bf68f4d5195b14 --- doc/requirements.txt | 6 +++--- doc/source/conf.py | 10 ++++++---- releasenotes/source/conf.py | 9 +++++---- 3 files changed, 14 insertions(+), 11 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index ab877bb..1fc85f4 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -2,7 +2,7 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -openstackdocstheme>=1.31.2 # Apache-2.0 -sphinx>=1.8.0,!=2.1.0 # BSD -reno>=2.5.0 # Apache-2.0 +openstackdocstheme>=2.2.1 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD +reno>=3.1.0 # Apache-2.0 sphinxcontrib-httpdomain>=1.3.0 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index 0859358..402cc45 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -35,9 +35,11 @@ extensions = ['sphinx.ext.autodoc', ] # openstackdocstheme options -repository_name = 'openstack/blazar-dashboard' -bug_project = 'blazar' -bug_tag = '' +openstackdocs_repo_name = 'openstack/blazar-dashboard' +openstackdocs_pdf_link = True +openstackdocs_auto_name = False +openstackdocs_bug_project = 'blazar' +openstackdocs_bug_tag = '' # Add any paths that contain templates here, relative to this directory. # templates_path = ['_templates'] @@ -85,7 +87,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/releasenotes/source/conf.py b/releasenotes/source/conf.py index e5bf311..8e57d02 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -43,9 +43,10 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/blazar-dashboard' -bug_project = 'blazar' -bug_tag = '' +openstackdocs_repo_name = 'openstack/blazar-dashboard' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'blazar' +openstackdocs_bug_tag = '' # Add any paths that contain templates here, relative to this directory. # templates_path = ['_templates'] @@ -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 = []