From: Mike Bayer <mike_mp@zzzcomputing.com>
Date: Sat, 22 Jul 2017 20:32:01 +0000 (-0400)
Subject: - move to file-per-changelog for unreleased change notes,
X-Git-Tag: rel_1_0_18~4
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=011c4ec0ed931dc6e5cc31f6d7a08142307686bd;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git

- move to file-per-changelog for unreleased change notes,
so that we no longer have to rely upon merges within
the changelog files.   because gerrit doesn't allow us
to use custom merge engines unlike git, we have no ability
to merge multiple changes into the changelog files without
going through conflicts.   new version of changelog
in git supports these new patterns.

Change-Id: I588eebd027b4ad3428bd522f36a6f1cd77f105bb
(cherry picked from commit 39c72682b85c1d3912ced383733d03eca7a43845)
---

diff --git a/doc/build/changelog/changelog_10.rst b/doc/build/changelog/changelog_10.rst
index c9d9a7fe8c..633e764970 100644
--- a/doc/build/changelog/changelog_10.rst
+++ b/doc/build/changelog/changelog_10.rst
@@ -18,16 +18,7 @@
 
 .. changelog::
     :version: 1.0.18
-
-    .. change:: 3937
-        :tags: bug, oracle
-        :tickets: 3937
-        :versions: 1.1.7
-
-        A fix to cx_Oracle's WITH_UNICODE mode which was uncovered by the
-        fact that cx_Oracle 5.3 now seems to hardcode this flag on in
-        the build; an internal method that uses this mode wasn't using
-        the correct signature.
+    :include_notes_from: unreleased_10
 
 
 .. changelog::
diff --git a/doc/build/changelog/unreleased_10/3937.rst b/doc/build/changelog/unreleased_10/3937.rst
new file mode 100644
index 0000000000..191da65e8e
--- /dev/null
+++ b/doc/build/changelog/unreleased_10/3937.rst
@@ -0,0 +1,9 @@
+.. change:: 3937
+    :tags: bug, oracle
+    :tickets: 3937
+    :versions: 1.1.7
+
+    A fix to cx_Oracle's WITH_UNICODE mode which was uncovered by the
+    fact that cx_Oracle 5.3 now seems to hardcode this flag on in
+    the build; an internal method that uses this mode wasn't using
+    the correct signature.
diff --git a/doc/build/changelog/unreleased_10/README.txt b/doc/build/changelog/unreleased_10/README.txt
new file mode 100644
index 0000000000..0a61f139bb
--- /dev/null
+++ b/doc/build/changelog/unreleased_10/README.txt
@@ -0,0 +1,11 @@
+Individual per-changelog files go here
+in .rst format, which are pulled in by
+changelog (version 0.4.0 or higher) to 
+be rendered into the changelog_xx.rst file.
+At release time, the files here are removed and written
+directly into the changelog.
+
+Rationale is so that multiple changes being merged
+into gerrit don't produce conflicts.   Note that 
+gerrit does not support custom merge handlers unlike
+git itself.
diff --git a/doc/build/conf.py b/doc/build/conf.py
index 5edbb08470..b04ba10b3b 100644
--- a/doc/build/conf.py
+++ b/doc/build/conf.py
@@ -27,7 +27,7 @@ import sqlalchemy
 # -- General configuration -----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+needs_sphinx = '1.6.0'
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
@@ -72,6 +72,11 @@ changelog_render_pullreq = {
 
 changelog_render_changeset = "http://www.sqlalchemy.org/trac/changeset/%s"
 
+exclude_patterns = [
+    'build',
+    '**/unreleased*/*',
+]
+
 autodocmods_convert_modname = {
     "sqlalchemy.sql.sqltypes": "sqlalchemy.types",
     "sqlalchemy.sql.type_api": "sqlalchemy.types",
@@ -117,7 +122,7 @@ site_adapter_py = "docs_adapter.py"
 
 # arbitrary number recognized by builders.py, incrementing this
 # will force a rebuild
-build_number = 3
+build_number = "3"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -129,10 +134,6 @@ build_number = 3
 # Else, today_fmt is used as the format for a strftime call.
 #today_fmt = '%B %d, %Y'
 
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns = ['build']
-
 # The reST default role (used for this markup: `text`) to use for all documents.
 #default_role = None
 
diff --git a/doc/build/requirements.txt b/doc/build/requirements.txt
index b7141c62a3..3836719d9f 100644
--- a/doc/build/requirements.txt
+++ b/doc/build/requirements.txt
@@ -1,3 +1,3 @@
-changelog>=0.3.5
-sphinx-paramlinks>=0.3.3
+git+https://bitbucket.org/zzzeek/changelog.git@HEAD#egg=changelog
+git+https://bitbucket.org/zzzeek/sphinx-paramlinks.git@HEAD#egg=sphinx-paramlinks
 git+https://bitbucket.org/zzzeek/zzzeeksphinx.git@HEAD#egg=zzzeeksphinx