From 1c689671ab19b1e47b4ecc9b386b4df9a4dc1a8a Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Fri, 17 Nov 2017 10:26:46 +0100 Subject: [PATCH] Remove setting of version/release from releasenotes Release notes are version independent, so remove version/release values. We've found that projects now require the service package to be installed in order to build release notes, and this is entirely due to the current convention of pulling in the version information. Release notes should not need installation in order to build, so this unnecessary version setting needs to be removed. Also, convert using openstackdocstheme. This is needed for new release notes publishing, see I56909152975f731a9d2c21b2825b972195e48ee8 and the discussion starting at http://lists.openstack.org/pipermail/openstack-dev/2017-November/124480.html . Change-Id: I3f53408447d75e36972eafb6cd71fbc770ee6b03 --- releasenotes/source/conf.py | 21 +++++++++++++-------- test-requirements.txt | 4 ++-- 2 files changed, 15 insertions(+), 10 deletions(-) diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index c1a48a05c..e176b13d2 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -28,7 +28,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] @@ -48,14 +48,17 @@ master_doc = 'index' project = u'Packstack Release Notes' copyright = u'2016, Packstack Developers' -# 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. -# +# Release notes do not need a version number in the title, they +# cover multiple releases. # The short X.Y version. -version = '8.0.0' +version = '' # The full version, including alpha/beta/rc tags. -release = '8.0.0' +release = '' + +# openstackdocstheme options +repository_name = 'openstack/packstack' +bug_project = 'packstack' +bug_tag = '' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -100,7 +103,7 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = 'openstackdocs' # 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 @@ -139,6 +142,8 @@ html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. # html_last_updated_fmt = '%b %d, %Y' +# 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. diff --git a/test-requirements.txt b/test-requirements.txt index 8cfc54a0d..515e65c4d 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,5 +1,5 @@ -sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 -oslosphinx>=2.5.0 # Apache-2.0 +sphinx>=1.6.2 # BSD +openstackdocstheme>=1.17.0 # Apache-2.0 reno>=0.1.1 # Apache2 os-testr>=0.4.1 # Apache-2.0 coverage