From 62f6e5b5c894fa418deccab51c12e388c5048cc8 Mon Sep 17 00:00:00 2001 From: RoadrunnerWMC Date: Sun, 10 Feb 2019 18:35:51 -0700 Subject: [PATCH] Prepare for 3.0.0 release --- docs/source/changelog.rst | 63 ++++++++++++++++++++++++++++++--------- docs/source/conf.py | 4 +-- ndspy/__init__.py | 2 +- setup.py | 2 +- 4 files changed, 53 insertions(+), 18 deletions(-) diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst index 90754aa..489de9d 100644 --- a/docs/source/changelog.rst +++ b/docs/source/changelog.rst @@ -25,24 +25,38 @@ can be downloaded from the `Releases page on GitHub .. contents:: :local: -1.0.0 (Jan. 18, 2019) ---------------------- -First release! The API has changed a lot in the weeks prior to this release, so -if you find yourself in possession of any code written for pre-1.0.0 ndspy, -you'll probably need to make adjustments. - -.. note:: +3.0.0 (Feb. 10, 2019) +--------------------- - This release had to be removed from PyPI due to a bug fixed in 1.0.1. If - you really must have it for some reason, you can find it `on GitHub - `_. +* Completely redesigned :py:mod:`ndspy.narc`'s API in order to add + compatibility with *New Super Mario Bros.* This is a very + backwards-incompatible change, and any code using the module definitely + needs to be updated. +* Medium-sized changes to :py:mod:`ndspy.bmg`'s API in order to add + compatibility with... pretty much game except *The Legend of Zelda: Phantom + Hourglass* and *The Legend of Zelda: Spirit Tracks.* This is a pretty + important change, of course, but it's also backwards-incompatible. + Depending on what parts of the module your code uses, though, your code + might still run correctly without any changes. +* Converted the names of + :py:class:`ndspy.soundSequence.MonoPolySequenceEvent.Value` and + :py:class:`ndspy.soundSequence.VibratoTypeSequenceEvent.Value` members to + upper-case, since that's the recommended style for enum members now. This + is backward-incompatible, but only if your code uses these enums. +* Added the first two tutorials to the documentation, and added example code + for certain modules. +* Reorganized the folder structure of the documentation. This makes most + previous documentation links invalid, unfortunately, but the reorganization + was done with an eye toward avoiding this having to happen again in the + future. +* Changes pertaining to undocumented modules: -1.0.1 (Jan. 18, 2019) ---------------------- + * :py:mod:`ndspy.bnbl` and :py:mod:`ndspy.bncl` were added + * :py:mod:`ndspy.graphics2D` got some API improvements + * Swapped the interpretation of alpha values in :py:mod:`ndspy.color` + * Added the ability to render textures with :py:mod:`ndspy.texture` -Fixed an issue that caused pip to erroneously attempt to install on unsupported -versions of Python, instead of giving the correct error message. 2.0.0 (Jan. 23, 2019) --------------------- @@ -56,3 +70,24 @@ versions of Python, instead of giving the correct error message. your code didn't crash on 1.0.x, this doesn't affect you. * Added :py:data:`ndspy.VERSION`. * Added this changelog page to the documentation. + + +1.0.1 (Jan. 18, 2019) +--------------------- + +Fixed an issue that caused pip to erroneously attempt to install on unsupported +versions of Python, instead of giving the correct error message. + + +1.0.0 (Jan. 18, 2019) +--------------------- + +First release! The API has changed a lot in the weeks prior to this release, so +if you find yourself in possession of any code written for pre-1.0.0 ndspy, +you'll probably need to make adjustments. + +.. note:: + + This release had to be removed from PyPI due to a bug fixed in 1.0.1. If + you really must have it for some reason, you can find it `on GitHub + `_. diff --git a/docs/source/conf.py b/docs/source/conf.py index a3f3bf8..c4b33d8 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -63,9 +63,9 @@ # built documents. # # The short X.Y version. -version = '2.0' +version = '3.0' # The full version, including alpha/beta/rc tags. -release = '2.0.0' +release = '3.0.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/ndspy/__init__.py b/ndspy/__init__.py index 12b36f0..9269401 100644 --- a/ndspy/__init__.py +++ b/ndspy/__init__.py @@ -23,7 +23,7 @@ import enum -VERSION = collections.namedtuple('version', 'major minor patch')(2, 0, 0) +VERSION = collections.namedtuple('version', 'major minor patch')(3, 0, 0) try: VERSION.__class__.__name__ = 'ndspy.version' except: pass diff --git a/setup.py b/setup.py index 6835d8b..29640e8 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ setuptools.setup( name='ndspy', - version='2.0.0', + version='3.0.0', author='RoadrunnerWMC', author_email='roadrunnerwmc@gmail.com', description='Python library that can help you read, modify and create many types of files used in Nintendo DS games.',