From 6d05c1932d4c25cfd63d66de6ae98ff097c0c7c2 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Thu, 16 Nov 2017 20:52:37 +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: I39b0501425823fa24996f2f215fa326453ed72c9 --- releasenotes/source/conf.py | 23 ++++++++++++----------- test-requirements.txt | 1 + 2 files changed, 13 insertions(+), 11 deletions(-) diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 91faedf0..6de36149 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -21,7 +21,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] @@ -41,16 +41,16 @@ master_doc = 'index' project = u'Sahara Dashboard Release Notes' copyright = u'2013, Sahara 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 sahara_dashboard.version import version_info as sahara_version +# Release notes are version independent. # The full version, including alpha/beta/rc tags. -release = sahara_version.version_string_with_vcs() +release = '' # The short X.Y version. -version = sahara_version.canonical_version_string() +version = '' + +# openstackdocstheme options +repository_name = 'openstack/sahara-dashboard' +bug_project = 'sahara-dashboard' +bug_tag = '' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -95,7 +95,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 @@ -124,7 +124,7 @@ html_theme = 'default' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +# html_static_path = ['_static'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied @@ -134,6 +134,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 15c33d06..440c50b4 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -15,6 +15,7 @@ python-subunit>=1.0.0 # Apache-2.0/BSD selenium>=2.50.1 # Apache-2.0 sphinx>=1.6.2 # BSD oslosphinx>=4.7.0 # Apache-2.0 +openstackdocstheme>=1.17.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD testtools>=2.2.0 # MIT