openstack
/
reno
Code Issues Proposed changes

fix sphinxext scanner when it has a list of versions to include 

Only stop at the branch base if we have not been told explicitly which
versions to include.

Change-Id: I2488f614e6d2fec0cb7babce1258ae0c64e77e2d
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
Doug Hellmann 2017-03-02 14:28:06 -05:00
parent 2e9cd7cfe5
commit 3387cfb3a6
2 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
releasenotes/notes/fix-sphinxext-scanner-0aa012ada66db773.yaml Normal file
View File

@ -0,0 +1,8 @@
---
fixes:
- |
Fixes a problem with the sphinx extension that caused it to
produce an error if it had a list of versions to include that were
not within the set that seemed to be on the branch because of the
branch-base detection logic. Now if a list of versions is
included, the scan always includes the full history.

4
reno/sphinxext.py
View File

@ -66,7 +66,9 @@ class ReleaseNotesDirective(rst.Directive):
# out how Sphinx passes a "false" flag later.
# 'collapse-pre-releases' in self.options
opt_overrides['collapse_pre_releases'] = True
opt_overrides['stop_at_branch_base'] = True
# Only stop at the branch base if we have not been told
# explicitly which versions to include.
opt_overrides['stop_at_branch_base'] = (version_opt is None)
if 'earliest-version' in self.options:
opt_overrides['earliest_version'] = self.options.get(
'earliest-version')