New "whatsnew" documents, sort of look like h5py. #237

This commit is contained in:
jevans 2014-05-22 21:35:20 -04:00
commit 298c493029
3 changed files with 85 additions and 0 deletions

View file

@ -0,0 +1,50 @@
=====================
Changes in glymur 0.5
=====================
Changes in 0.5.12
=================
* Minor documentation fixes for grammar and style.
* The functions removed in 0.5.11 due to API changes in OpenJPEG 2.1.0 were
restored for backwards compatibility. They are deprecated, though, and will
be removed in 0.6.0.
* ``glymur.lib.openjp2.stream_create_default_file_stream_v3``
* ``glymur.lib.openjp2.opj.stream_destroy_v3``
Changes in 0.5.11
=================
* Added support for Python 3.4.
* OpenJPEG 1.5.2 and 2.0.1 are officially supported.
* OpenJPEG 2.1.0 is officially supported, but the ABI changes introduced by
OpenJPEG 2.1.0 required corresponding changes to glymur's ctypes interface.
The functions
* ``glymur.lib.openjp2.stream_create_default_file_stream_v3``
* ``glymur.lib.openjp2.opj.stream_destroy_v3``
functions were renamed to
* ``glymur.lib.openjp2.stream_create_default_file_stream``
* ``glymur.lib.openjp2.opj.stream_destroy``
in order to follow OpenJPEG's upstream changes. Unless you were using the
svn version of OpenJPEG, you should not be affected by this.
Changes in 0.5.10
=================
* Fixed bad warning issued when an unsupported reader requirement box mask
length was encountered.
Changes in 0.5.9
================
* Fixed bad library load on linux as a result of botched 0.5.8 release.
This release was primarily aimed at supporting SunPy.

View file

@ -0,0 +1,23 @@
=====================
Changes in glymur 0.6
=====================
Changes in 0.6.0
=================
* Added Cinema2K, Cinema4K write support.
* Added irreversible 9-7 transform write support.
* Added set_printoptions, get_printoptions functions.
* Added write support for JP2 UUID, data entry URL, palette, and component
mapping boxes.
* Added read/write support for JPX free, number list, and data reference boxes
* Added read support for JPX fragment list and fragment table boxes
* Incompatible change to channel definition box constructor, channel_type and
association are no longer keyword arguments
* Incompatible change to palette box constructor, it now takes a 2D numpy array
instead of a list of 1D arrays
* Dropped support for 1.3 and 1.4.
* Dropped support for Python 2.6.
* Dropped windows support. It might still work, I don't have access to a windows
box with which to test it.
* Added lxml as a package dependency, replacing ElementTree.

View file

@ -0,0 +1,12 @@
.. _whatsnew:
**********************
"What's new" documents
**********************
These document the changes between minor (or major) versions of glymur.
.. toctree::
0.5
0.6