From e6e9b657599ce453bffaa22c8c51e1ee38941b6b Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Fri, 17 Nov 2017 10:14:14 +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, use openstackdocstheme for releasenotes. 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: I05b9635372ae912fc16f72641ecf01132a7cc810 --- releasenotes/source/conf.py | 22 ++++++++++++---------- test-requirements.txt | 3 ++- 2 files changed, 14 insertions(+), 11 deletions(-) diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 3a0a315..b45e666 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -44,7 +44,7 @@ sys.path.insert(0, os.path.abspath('./')) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] @@ -64,16 +64,17 @@ master_doc = 'index' project = u'K8s Docker Suite Release Notes' copyright = u'2016, K8s Docker Suite 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. -# -# The short X.Y version. -from releasenotes.source.version import version_info as k8s_docker_version +# Release notes do not need a version number in the title, they +# cover multiple releases. # The full version, including alpha/beta/rc tags. -release = k8s_docker_version.version_string_with_vcs() +release = '' # The short X.Y version. -version = k8s_docker_version.canonical_version_string() +version = '' + +# openstackdocstheme options +repository_name = 'openstack/k8s-docker-suite-app-murano' +bug_project = 'k8s-docker-suite-app-murano' +bug_tag = '' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -118,7 +119,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 @@ -157,6 +158,7 @@ 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' +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 03c8d7a..da72892 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,7 +1,8 @@ pbr>=1.6 # Apache-2.0 testtools requests -sphinx!=1.3b1,<1.3,>=1.2.1 # BSD +sphinx>=1.6.2 # BSD +openstackdocstheme>=1.17.0 # Apache-2.0 oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0 paramiko python-muranoclient