From c7da4424b9cd9b8a2cf0a6a79f7cb08bdeb61169 Mon Sep 17 00:00:00 2001 From: Yu-Jie Lin Date: Tue, 1 Oct 2013 09:46:41 +0800 Subject: tinker Changes and Copyright docs for headings mainly With headings, it's now cleaner and possible to be linked directly to specific release. Also add a simple guideline how to write the changelog. --- CHANGES.rst | 278 ++++++++++++++++++++++++++++++++++------------------- COPYING | 16 ++- Makefile | 2 +- docs/copyright.rst | 3 - 4 files changed, 195 insertions(+), 104 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index d62459e..e6191e7 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -2,135 +2,219 @@ Changes ======= -Versions without timestamps mean they are future releases. +.. notes on writing changes -2.0.0: - - drop Pyblosxom support - - drop str-type ``attr`` + - use reStructuredText as much as possible, code in backticks or code blocks + - no period in the end of line + - lower case, base form, e.g. "add" and "remove" not "added" nor "adds" + - line wrapping at 80 characters, i.e. max line length is 79 characters + - use symbols, even though they look same in Sphinx doc - - use ``Attr.default`` instead of ``default_smartypants_attr`` + - "*" for modifications, fixes, or a set of grouped changes + - "+" for additions + - "-" for removals - - drop fooBarXyz functions, such as ``smartyPants``, ``educateQuotes``, - and ``processEscapes`` + .. note:: need to group each type into block, if without blank lines to + separate, Sphinx gives warnings. -development: - - fix ``_tokenize`` can not handle HTML comment properly + Normally, they should be ordered in and separated by blank lines + + - deprecates - This fix includes pull request #1 with modification for handling - ``--`` appears in a comment, which makes the comment not a comment. + - removals -1.8.2: 2013-08-28T11:38:42Z - - add documentation generation - - setup.py + * fixes - - add ``build_sphinx`` and ``upload_sphinx`` commands + * sets - - Makefile + - removals - - add ``doc`` for documentation generation - - add ``upload_doc`` for uploading to PyPI - - add ``clean`` for cleaning up built files + + additions - - fix ``---`` being converted in ``educateDashes`` + + additions - The Perl doesn't do such, and it's possibly a mistaken in - version v1.5_1.5 (eed4a8a16f11). - If you want the same behavior with default attributes, you need to use - ``Attr.q | Attr.b | Attr.i | Attr.e``. +Future +====== - - deprecate fooBarXyz functions, such as ``educateQuotes`` and - ``processEscapes`` +Release 2.0.0 +------------- -1.8.1: 2013-08-20T02:27:35Z - - fix deprecated ``smartyPants`` returns nothing (#2) - - add test file for deprecated stuff +- drop Pyblosxom support -1.8.0: 2013-08-18T11:47:27Z - - command-line +- drop str-type ``attr`` - - add ``--version`` - - add ``--skip`` for skipped elements + - use ``Attr.default`` instead of ``default_smartypants_attr`` - - add Makefile: +- drop fooBarXyz functions, such as ``smartyPants``, ``educateQuotes``, + and ``processEscapes`` - - ``test_pep8``, ``test_pyflakes``, and ``test_test`` (unittest) - targets - - ``install_test`` target for checking package installation - - ``test`` target for all tests above - - add ``style``, ``samp``, and ``tt`` to be skipped HTML elements - - remove ``tags_to_skip_regex`` and add ``tags_to_skip`` as a list of - skipped HTML with a helper function to compile a regular expreesion - - deprecate str-type ``attr`` with: +Development +=========== - - redesign attr input with new ``Attr`` object +* fix ``_tokenize`` can not handle HTML comment properly - - ``"-1"`` now is ``Attr.s`` (``"s"``) + This fix includes pull request #1 with modification for handling + ``--`` appears in a comment, which makes the comment not a comment - - ``_str_attr_to_int()`` to handle str-type before the removal - - deprecate function name ``smartyPants``, now ``smartypants`` +Releases 1.7 and greater +======================== -1.7.1: 2013-08-14T06:45:59Z - - fix ``README-PyPI.rst`` missing while installing +Release 1.8.2: 2013-08-28T11:38:42Z +----------------------------------- -1.7.0: 2013-08-14T05:51:20Z - - deprecate Pyblosxom support - - fix ``convert_quot`` always enabled +- deprecate fooBarXyz functions, such as ``educateQuotes`` and + ``processEscapes`` - It was always turned on. To have same effect of previous ``1`` attr, - equivalent attrs are ``qbdew``. Now ``1`` means ``qbde``. +* fix ``---`` being converted in ``educateDashes`` - - add Python 3 support - - add unittest and checks - - add CLI script + The Perl doesn't do such, and it's possibly a mistaken in + version v1.5_1.5 (eed4a8a16f11) ----- + If you want the same behavior with default attributes, you need to use + ``Attr.q | Attr.b | Attr.i | Attr.e`` + +* setup.py + + - add ``build_sphinx`` and ``upload_sphinx`` commands + +* Makefile + + - add ``doc`` for documentation generation + - add ``upload_doc`` for uploading to PyPI + - add ``clean`` for cleaning up built files + ++ add documentation generation + +Release 1.8.1: 2013-08-20T02:27:35Z +----------------------------------- + +- fix deprecated ``smartyPants`` returns nothing (#2) + ++ add test file for deprecated stuff + +Release 1.8.0: 2013-08-18T11:47:27Z +----------------------------------- + +- deprecate str-type ``attr`` with: + + - redesign attr input with new ``Attr`` object + + - ``"-1"`` now is ``Attr.s`` (``"s"``) + + - ``_str_attr_to_int()`` to handle str-type before the removal + +- deprecate function name ``smartyPants``, now ``smartypants`` + +- remove ``tags_to_skip_regex`` and add ``tags_to_skip`` as a list of + skipped HTML with a helper function to compile a regular expression + +* command-line + + - add ``--version`` + - add ``--skip`` for skipped elements + +* add Makefile: + + - ``test_pep8``, ``test_pyflakes``, and ``test_test`` (unittest) + targets + - ``install_test`` target for checking package installation + - ``test`` target for all tests above + ++ add ``style``, ``samp``, and ``tt`` to be skipped HTML elements + +Release 1.7.1: 2013-08-14T06:45:59Z +----------------------------------- + +* fix ``README-PyPI.rst`` missing while installing + +Release 1.7.0: 2013-08-14T05:51:20Z +----------------------------------- + +- deprecate Pyblosxom support + +- remove HBS language translation added in 1.5_1.7. + +* fix ``convert_quot`` always enabled + + It was always turned on. To have same effect of previous ``1`` attr, + equivalent attrs are ``qbdew``. Now ``1`` means ``qbde`` + ++ add Python 3 support ++ add unittest and checks ++ add CLI script + +Releases 1.6 +============ The following releases were made by Hao Lian: -1.6.0.3: 2009-04-21 - - ``smartypants.py`` exactly the same as 1.5_1.6 -1.6.0.2: 2008-12-20 - - ``smartypants.py`` exactly the same as 1.5_1.6 +Release 1.6.0.3: 2009-04-21 +--------------------------- + +``smartypants.py`` exactly the same as 1.5_1.6 ----- +Release 1.6.0.2: 2008-12-20 +--------------------------- + +``smartypants.py`` exactly the same as 1.5_1.6 + + +Releases 1.5 +============ The following releases were made by Chad Miller: -1.5_1.7: Fri, 09 Aug 2013 07:34:16 -0400 - - Add HBS language translation. Patch by by Vera Djuraskovic from - Webhostinggeeks.com - - Add Python3 support. - -1.5_1.6: Fri, 27 Jul 2007 07:06:40 -0400 - - Fixed bug where blocks of precious unalterable text was instead - interpreted. Thanks to Le Roux and Dirk van Oosterbosch. - -1.5_1.5: Sat, 13 Aug 2005 15:50:24 -0400 - - Fix bogus magical quotation when there is no hint that the - user wants it, e.g., in "21st century". Thanks to Nathan Hamblen. - - Be smarter about quotes before terminating numbers in an en-dash'ed - range. - -1.5_1.4: Thu, 10 Feb 2005 20:24:36 -0500 - - Fix a date-processing bug, as reported by jacob childress. - - Begin a test-suite for ensuring correct output. - - Removed import of "string", since I didn't really need it. - (This was my first every Python program. Sue me!) - -1.5_1.3: Wed, 15 Sep 2004 18:25:58 -0400 - - Abort processing if the flavour is in forbidden-list. Default of - [ "rss" ] (Idea of Wolfgang SCHNERRING.) - - Remove stray virgules from en-dashes. Patch by Wolfgang SCHNERRING. - -1.5_1.2: Mon, 24 May 2004 08:14:54 -0400 - - Some single quotes weren't replaced properly. Diff-tesuji played - by Benjamin GEIGER. - -1.5_1.1: Sun, 14 Mar 2004 14:38:28 -0500 - - Support upcoming pyblosxom 0.9 plugin verification feature. - -1.5_1.0: Tue, 09 Mar 2004 08:08:35 -0500 - - Initial release +Release 1.5_1.7: Fri, 09 Aug 2013 07:34:16 -0400 +------------------------------------------------ + +- Add HBS language translation. Patch by by Vera Djuraskovic from + Webhostinggeeks.com +- Add Python3 support + +Release 1.5_1.6: Fri, 27 Jul 2007 07:06:40 -0400 +------------------------------------------------ + +- Fixed bug where blocks of precious unalterable text was instead + interpreted. Thanks to Le Roux and Dirk van Oosterbosch + +Release 1.5_1.5: Sat, 13 Aug 2005 15:50:24 -0400 +------------------------------------------------ + +- Fix bogus magical quotation when there is no hint that the + user wants it, e.g., in "21st century". Thanks to Nathan Hamblen +- Be smarter about quotes before terminating numbers in an en-dash'ed + range + +Release 1.5_1.4: Thu, 10 Feb 2005 20:24:36 -0500 +------------------------------------------------ + +- Fix a date-processing bug, as reported by jacob childress +- Begin a test-suite for ensuring correct output +- Removed import of "string", since I didn't really need it + (This was my first every Python program. Sue me!) + +Release 1.5_1.3: Wed, 15 Sep 2004 18:25:58 -0400 +------------------------------------------------ + +- Abort processing if the flavour is in forbidden-list. Default of + [ "rss" ] (Idea of Wolfgang SCHNERRING.) +- Remove stray virgules from en-dashes. Patch by Wolfgang SCHNERRING + +Release 1.5_1.2: Mon, 24 May 2004 08:14:54 -0400 +------------------------------------------------ + +- Some single quotes weren't replaced properly. Diff-tesuji played + by Benjamin GEIGER + +Release 1.5_1.1: Sun, 14 Mar 2004 14:38:28 -0500 +------------------------------------------------ + +- Support upcoming pyblosxom 0.9 plugin verification feature + +Release 1.5_1.0: Tue, 09 Mar 2004 08:08:35 -0500 +------------------------------------------------ + +- Initial release diff --git a/COPYING b/COPYING index 829b115..b112a89 100644 --- a/COPYING +++ b/COPYING @@ -1,4 +1,11 @@ -SmartyPants license:: +========= +Copyright +========= + +SmartyPants +=========== + +:: Copyright (c) 2003 John Gruber (http://daringfireball.net/) @@ -33,9 +40,12 @@ SmartyPants license:: of this software, even if advised of the possibility of such damage. -smartypants.py license:: +smartypants +=========== + +:: - smartypants.py is a derivative work of SmartyPants. + smartypants is a derivative work of SmartyPants. Copyright (c) 2013 Yu-Jie Lin Copyright (c) 2004, 2005, 2007, 2013 Chad Miller diff --git a/Makefile b/Makefile index ee10fcb..b8b6c32 100644 --- a/Makefile +++ b/Makefile @@ -15,7 +15,7 @@ VENV_PY3_CMD=virtualenv-python3.2 BUILD_CMD=./setup.py sdist --formats gztar,zip bdist_wininst --plat-name win32 -DOC_FILES = CHANGES.rst docs/conf.py $(wildcard docs/*.rst) +DOC_FILES = CHANGES.rst COPYING docs/conf.py $(wildcard docs/*.rst) # ============================================================================ diff --git a/docs/copyright.rst b/docs/copyright.rst index 52bbc38..65cb9f1 100644 --- a/docs/copyright.rst +++ b/docs/copyright.rst @@ -1,4 +1 @@ -Copyright -========= - .. include:: ../COPYING -- cgit v1.2.1