From 80aa69fb76bdc06d00dd25e29fcfac49ec8e4d3d Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sun, 31 May 2020 19:45:50 +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. 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: Ib09fb7435a88f15147befd4448279d5b82bd3fcc --- doc/requirements.txt | 6 +++--- releasenotes/source/conf.py | 7 +++---- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 6599d80..56f8df5 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,6 +1,6 @@ # 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.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD -openstackdocstheme>=1.20.0 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index bb6e558..90b599f 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -37,14 +37,13 @@ source_encoding = 'utf-8' master_doc = 'index' # General information about the project. -repository_name = u'openstack/monasca-notification' +openstackdocs_repo_name = u'openstack/monasca-notification' # Release notes do not need a version number in the title, they # cover multiple releases. version = '' release = '' -bug_project = 'monasca-notification' -bug_tag = u'' +openstackdocs_use_storyboard = True copyright = u'2014-present, OpenStack Foundation' author = u'OpenStack Foundation' @@ -78,7 +77,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 = []