From 952566d76ec103b5fdc7bba3e924933c31aa841c Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Thu, 28 May 2020 14:41:05 +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_version to not auto-version the documents. 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: I6f7b0e00c112f62dd94a907284fcb3698e84479d --- deploy-guide/source/conf.py | 10 ++++++---- doc/requirements.txt | 2 +- doc/source/conf.py | 10 ++++++---- requirements.txt | 2 +- 4 files changed, 14 insertions(+), 10 deletions(-) diff --git a/deploy-guide/source/conf.py b/deploy-guide/source/conf.py index aef3a016..638ecc15 100644 --- a/deploy-guide/source/conf.py +++ b/deploy-guide/source/conf.py @@ -85,7 +85,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 = [] @@ -124,6 +124,8 @@ rst_prolog = """ """ % (project, bug_tracker, bug_tracker_url) # openstackdocstheme options -repository_name = 'openstack/tripleo-docs' -bug_project = 'tripleo' -bug_tag = 'documentation' +openstackdocs_repo_name = 'openstack/tripleo-docs' +openstackdocs_auto_name = False +openstackdocs_auto_version = False +openstackdocs_bug_project = 'tripleo' +openstackdocs_bug_tag = 'documentation' diff --git a/doc/requirements.txt b/doc/requirements.txt index 9f4ab004..908ab3f8 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. -sphinx>=1.8.0,!=2.1.0 # BSD +sphinx>=2.0.0,!=2.1.0 # BSD sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD sphinxcontrib-mermaid>=0.3.1 # BSD requests diff --git a/doc/source/conf.py b/doc/source/conf.py index 0f793637..fb8028f1 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -94,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 = [] @@ -188,6 +188,8 @@ rst_prolog = """ ) # openstackdocstheme options -repository_name = 'openstack/tripleo-docs' -bug_project = 'tripleo' -bug_tag = 'documentation' +openstackdocs_repo_name = 'openstack/tripleo-docs' +openstackdocs_pdf_link = True +openstackdocs_auto_name = False +openstackdocs_bug_project = 'tripleo' +openstackdocs_bug_tag = 'documentation' diff --git a/requirements.txt b/requirements.txt index 3f22bc6a..570933f6 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,4 +2,4 @@ # 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 +openstackdocstheme>=2.2.1 # Apache-2.0