Commits

Mike Bayer committed 533e9ca

- switch to changelog extension

Comments (0)

Files changed (5)

CHANGES

-0.4.0
-=====
-- [bug] Using dogpile.core 0.4.0 now, fixes a critical
-  bug whereby dogpile pileup could occur on first value
-  get across multiple processes, due to reliance upon
-  a non-shared creation time.  This is dogpile.core
-  issue #1.
-
-- [bug] Fixed missing __future__ with_statement
-  directive in region.py.
-
-0.3.1
-=====
-- [bug] Fixed the mako_cache plugin which was not yet
-  covered, and wasn't implementing the mako plugin
-  API correctly; fixed docs as well.  Courtesy
-  Ben Hayden.
-
-- [bug] Fixed setup so that the tests/* directory
-  isn't yanked into the install.  Courtesy Ben Hayden.
-
-0.3.0
-=====
-- [feature] get() method now checks expiration time
-  by default.   Use ignore_expiration=True
-  to bypass this.
-
-- [feature] Added new invalidate() method.  Sets the current
-  timestamp as a minimum value that all retrieved
-  values must be created after.  Is honored by the
-  get_or_create() and get() methods. #7
-
-- [bug] Fixed bug whereby region.get() didn't
-  work if the value wasn't present.  #8
-
-0.2.4
-=====
-- Fixed py3k issue with config string coerce,
-  courtesy Alexander Fedorov
-
-0.2.3
-=====
-- support "min_compress_len" and "memcached_expire_time"
-  with python-memcached backend.  Tests courtesy
-  Justin Azoff #3
-
-- Add support for coercion of string config values
-  to Python objects - ints, "false", "true", "None".
-  #4
-
-- Added support to DBM file lock to allow reentrant
-  access per key within a single thread, so that
-  even though the DBM backend locks for the whole file,
-  a creation function that calls upon a different
-  key in the cache can still proceed.  #5
-
-- Fixed DBM glitch where multiple readers
-  could be serialized.
-
-- Adjust bmemcached backend to work with newly-repaired
-  bmemcached calling API (see bmemcached
-  ef206ed4473fec3b639e).
-
-0.2.2
-=====
-- add Redis backend, courtesy Ollie Rutherfurd
-
-0.2.1
-=====
-- move tests into tests/cache namespace
-- py3k compatibility is in-place now, no
-  2to3 needed.
-
-0.2.0
-=====
-
-- Based on dogpile.core now, to get the package
-  namespace thing worked out.
-
-0.1.1
-=====
-- Fixed the configure_from_config() method of region
-  and backend which wasn't working.  Courtesy
-  Christian Klinger.
-
-0.1.0
-=====
-Initial release.
-
-Includes a pylibmc backend and a plain dictionary backend.

docs/build/changelog.rst

+==============
+Changelog
+==============
+
+.. changelog::
+    :version: 0.4.0
+    :released: Tue Oct 30 2012
+
+    .. change::
+        :tags: bug
+        :tickets: 1
+
+      Using dogpile.core 0.4.0 now, fixes a critical
+      bug whereby dogpile pileup could occur on first value
+      get across multiple processes, due to reliance upon
+      a non-shared creation time.  This is a dogpile.core
+      issue.
+
+    .. change::
+        :tags: bug
+        :tickets:
+
+      Fixed missing __future__ with_statement
+      directive in region.py.
+
+.. changelog::
+    :version: 0.3.1
+    :released: Tue Sep 25 2012
+
+    .. change::
+        :tags: bug
+        :tickets:
+
+      Fixed the mako_cache plugin which was not yet
+      covered, and wasn't implementing the mako plugin
+      API correctly; fixed docs as well.  Courtesy
+      Ben Hayden.
+
+    .. change::
+        :tags: bug
+        :tickets:
+
+      Fixed setup so that the tests/* directory
+      isn't yanked into the install.  Courtesy Ben Hayden.
+
+.. changelog::
+    :version: 0.3.0
+    :released: Thu Jun 14 2012
+
+    .. change::
+        :tags: feature
+        :tickets:
+
+      get() method now checks expiration time
+      by default.   Use ignore_expiration=True
+      to bypass this.
+
+    .. change::
+        :tags: feature
+        :tickets: 7
+
+      Added new invalidate() method.  Sets the current
+      timestamp as a minimum value that all retrieved
+      values must be created after.  Is honored by the
+      get_or_create() and get() methods.
+
+    .. change::
+        :tags: bug
+        :tickets: 8
+
+      Fixed bug whereby region.get() didn't
+      work if the value wasn't present.
+
+
+
+.. changelog::
+    :version: 0.2.4
+    :released:
+
+    .. change::
+        :tags:
+        :tickets:
+
+      Fixed py3k issue with config string coerce,
+      courtesy Alexander Fedorov
+
+.. changelog::
+    :version: 0.2.3
+    :released: Wed May 16 2012
+
+    .. change::
+        :tags:
+        :tickets: 3
+
+      support "min_compress_len" and "memcached_expire_time"
+      with python-memcached backend.  Tests courtesy
+      Justin Azoff
+
+    .. change::
+        :tags:
+        :tickets: 4
+
+      Add support for coercion of string config values
+      to Python objects - ints, "false", "true", "None".
+
+    .. change::
+        :tags:
+        :tickets: 5
+
+      Added support to DBM file lock to allow reentrant
+      access per key within a single thread, so that
+      even though the DBM backend locks for the whole file,
+      a creation function that calls upon a different
+      key in the cache can still proceed.
+
+    .. change::
+        :tags:
+        :tickets:
+
+      Fixed DBM glitch where multiple readers
+      could be serialized.
+
+    .. change::
+        :tags:
+        :tickets:
+
+      Adjust bmemcached backend to work with newly-repaired
+      bmemcached calling API (see bmemcached
+      ef206ed4473fec3b639e).
+
+.. changelog::
+    :version: 0.2.2
+    :released: Thu Apr 19 2012
+
+    .. change::
+        :tags:
+        :tickets:
+
+      add Redis backend, courtesy Ollie Rutherfurd
+
+.. changelog::
+    :version: 0.2.1
+    :released: Sun Apr 15 2012
+
+    .. change::
+        :tags:
+        :tickets:
+
+      move tests into tests/cache namespace
+
+    .. change::
+        :tags:
+        :tickets:
+
+      py3k compatibility is in-place now, no
+      2to3 needed.
+
+.. changelog::
+    :version: 0.2.0
+    :released: Sat Apr 14 2012
+
+    .. change::
+        :tags:
+        :tickets:
+
+      Based on dogpile.core now, to get the package
+      namespace thing worked out.
+
+
+
+.. changelog::
+    :version: 0.1.1
+    :released: Tue Apr 10 2012
+
+    .. change::
+        :tags:
+        :tickets:
+
+      Fixed the configure_from_config() method of region
+      and backend which wasn't working.  Courtesy
+      Christian Klinger.
+
+.. changelog::
+    :version: 0.1.0
+    :released: Sun Apr 08 2012
+
+    .. change::
+        :tags:
+        :tickets:
+
+       Initial release.
+
+    .. change::
+        :tags:
+        :tickets:
+
+       Includes a pylibmc backend and a plain dictionary backend.
+

docs/build/conf.py

 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'changelog']
+
+changelog_sections = ["feature", "bug"]
+
+changelog_render_ticket = "https://bitbucket.org/zzzeek/dogpile.cache/issue/%s"
+changelog_render_pullreq = "https://bitbucket.org/zzzeek/dogpile.cache/pullrequest/%s"
+changelog_render_changeset = "https://bitbucket.org/zzzeek/dogpile.cache/changeset/%s"
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

docs/build/index.rst

    front
    usage
    api
+   changelog
 
 Indices and tables
 ==================

docs/build/requirements.txt

 mako
 dogpile
+changelog
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.