From 489f9fbac24837b92b4ce2d37857c5a261138f7d Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Thu, 21 May 2020 10:29:43 +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. Remove docs requirements from lower-constraints, they are not needed during install or test but only for docs building. 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: I88d35727272813aa5371969e3ea3e763e1a12700 --- doc/requirements.txt | 6 +++--- doc/source/conf.py | 25 ++++++------------------- lower-constraints.txt | 5 ----- releasenotes/source/conf.py | 12 +++++------- 4 files changed, 14 insertions(+), 34 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 64bb34b..f34464e 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -8,7 +8,7 @@ # # Requirements for docs mock>=2.0.0 # BSD -openstackdocstheme>=1.18.1 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 -sphinx>=1.8.0,!=2.1.0 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD sphinxcontrib-apidoc>=0.2.0 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index b760f87..932f092 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -22,15 +22,11 @@ # All configuration values have a default; values that are commented out # serve to show the default. -from __future__ import print_function - import os import sys import django -from zun_ui import version as zunui_ver - BASE_DIR = os.path.dirname(os.path.abspath(__file__)) ROOT = os.path.abspath(os.path.join(BASE_DIR, "..", "..")) @@ -80,14 +76,6 @@ master_doc = 'index' project = u'Zun UI' copyright = u'2016, OpenStack Foundation' -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = zunui_ver.version_info.version_string() -# The full version, including alpha/beta/rc tags. -release = zunui_ver.version_info.release_string() # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -119,7 +107,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 = [] @@ -134,9 +122,11 @@ nitpicky = False html_theme = 'openstackdocs' # openstackdocstheme options -repository_name = 'openstack/zun-ui' -bug_project = 'zun-ui' -bug_tag = '' +openstackdocs_repo_name = 'openstack/zun-ui' +openstackdocs_pdf_link = True +openstackdocs_bug_project = 'zun-ui' +openstackdocs_bug_tag = '' +openstackdocs_auto_name = False # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -167,9 +157,6 @@ bug_tag = '' # so a file named "default.css" will overwrite the builtin "default.css". # html_static_path = [''] -# Must set this variable to include year, month, day, hours, and minutes. -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 diff --git a/lower-constraints.txt b/lower-constraints.txt index e3b9c6e..744048f 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -45,7 +45,6 @@ msgpack==0.5.6 munch==2.2.0 netaddr==0.7.19 netifaces==0.10.6 -openstackdocstheme==1.18.1 openstacksdk==0.12.0 os-client-config==1.29.0 os-service-types==1.2.0 @@ -80,7 +79,6 @@ python-zunclient==3.5.0 pytz==2018.3 PyYAML==3.12 rcssmin==1.0.6 -reno==2.5.0 requests==2.18.4 requestsexceptions==1.4.0 rfc3986==1.1.0 @@ -89,9 +87,6 @@ semantic-version==2.6.0 simplejson==3.13.2 six==1.11.0 snowballstemmer==1.2.1 -Sphinx==1.8.0 -sphinxcontrib-apidoc===0.2.0 -sphinxcontrib-websupport==1.0.1 stevedore==1.28.0 testtools==2.3.0 traceback2==1.4.0 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 8929057..7628428 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -91,7 +91,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 = [] @@ -107,9 +107,10 @@ pygments_style = 'sphinx' html_theme = 'openstackdocs' # openstackdocstheme options -repository_name = 'openstack/zun-ui' -bug_project = 'zun-ui' -bug_tag = '' +openstackdocs_repo_name = 'openstack/zun-ui' +openstackdocs_bug_project = 'zun-ui' +openstackdocs_bug_tag = '' +openstackdocs_auto_name = False # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -145,9 +146,6 @@ bug_tag = '' # directly to the root of the documentation. # html_extra_path = [] -# Must set this variable to include year, month, day, hours, and minutes. -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