From 40df15a462d24a86df008ccd2f65bd8f2b1d335c Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Thu, 21 May 2020 10:16:35 +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. Set openstackdocs_auto_name to use 'project' 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: I38ad719a8942ec1ae1c78e8d680e467b06815a20 --- doc/requirements.txt | 6 +++--- doc/source/conf.py | 8 +++++--- releasenotes/source/conf.py | 7 ++++--- 3 files changed, 12 insertions(+), 9 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 6fccf089..9a48fc42 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. -openstackdocstheme>=2.0.0 # Apache-2.0 -sphinx>=2.0.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 sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index 5008452b..72d0f7c4 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -42,8 +42,10 @@ project = u'Heat Dashboard' copyright = u'2017, OpenStack Developers' # openstackdocstheme options -repository_name = 'openstack/heat-dashboard' -use_storyboard = True +openstackdocs_repo_name = 'openstack/heat-dashboard' +openstackdocs_pdf_link = True +openstackdocs_use_storyboard = True +openstackdocs_auto_name = False # If true, '()' will be appended to :func: etc. cross-reference text. add_function_parentheses = True @@ -53,7 +55,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 97707707..555753f7 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -56,8 +56,9 @@ project = u'Heat Dashboard Release Notes' copyright = u'2017, OpenStack Foundation' # openstackdocstheme options -repository_name = 'openstack/heat-dashboard' -use_storyboard = True +openstackdocs_repo_name = 'openstack/heat-dashboard' +openstackdocs_use_storyboard = True +openstackdocs_auto_name = False # Release notes are version independent, no need to set version and release release = '' @@ -93,7 +94,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 = []