From 8f6764389b4afb11e49daa667171deffa54a07e7 Mon Sep 17 00:00:00 2001 From: Johannes Raggam Date: Fri, 2 Sep 2011 12:55:12 +0200 Subject: [PATCH] update documentation a bit --- CHANGES.txt | 36 --------------- HISTORY.txt | 77 --------------------------------- CREDITS.txt => docs/credits.rst | 13 +----- docs/index.rst | 2 + INSTALL.txt => docs/install.rst | 0 5 files changed, 3 insertions(+), 125 deletions(-) delete mode 100644 CHANGES.txt delete mode 100644 HISTORY.txt rename CREDITS.txt => docs/credits.rst (63%) rename INSTALL.txt => docs/install.rst (100%) diff --git a/CHANGES.txt b/CHANGES.txt deleted file mode 100644 index fb05925..0000000 --- a/CHANGES.txt +++ /dev/null @@ -1,36 +0,0 @@ -2.2 - unreleased -================ - -* ... - - -2.1 (2009-12-14) -================ - -* Fix deprecation warnings about `object.__init__` taking no parameters. - -* Set the VALUE parameter correctly for date values. - -* Long binary data would be base64 encoded with newlines, which made the - iCalendar files incorrect. (This still needs testing). - -* Correctly handle content lines which include newlines. - -iCalendar 2.0.1 (2008-07-11) -============================ - -* EXDATE and RDATE now returns a vDDDLists object, which contains a list - of vDDDTypes objects. This is do that EXDATE and RDATE can contain - lists of dates, as per RFC. - - ***Note!***: This change is incompatible with earlier behavior, so if you - handle EXDATE and RDATE you will need to update your code. - -* When createing a vDuration of -5 hours (which in itself is nonsensical), - the ical output of that was -P1DT19H, which is correct, but ugly. Now - it's '-PT5H', which is prettier. - -* Made the tests run under Python 2.5+ - -* Renamed the UTC class to Utc, so it would not clash with the UTC object, - since that rendered the UTC object unpicklable. diff --git a/HISTORY.txt b/HISTORY.txt deleted file mode 100644 index ee0b125..0000000 --- a/HISTORY.txt +++ /dev/null @@ -1,77 +0,0 @@ -iCalendar 1.2 (2006-11-25) -========================== - -* Fixed a string index out of range error in the new folding code. - - -iCalendar 1.1 (2006-11-23) -========================== - -* Fixed a bug in caselessdicts popitem. - (thanks to Michael Smith ) - -* The RFC 2445 was a bit unclear on how to handle line folding when it - happened to be in the middle of a UTF-8 character. This has been clarified - in the following discussion: - http://lists.osafoundation.org/pipermail/ietf-calsify/2006-August/001126.html - And this is now implemented in iCalendar. It will not fold in the middle - of a UTF-8 character, but may fold in the middle of a UTF-8 composing - character sequence. - - -iCalendar 1.0 (2006-08-03) -========================== - -* make get_inline and set_inline support non ascii codes. - -* Added support for creating a python egg distribution. - - -iCalendar 0.11 (2005-11-08) -=========================== - -* Changed component .from_string to use types_factory instead of - hardcoding entries to 'inline' - -* Changed UTC tzinfo to a singleton so the same one is used everywhere - -* Made the parser more strict by using regular expressions for key - name, param name and quoted/unquoted safe char as per the RFC - -* Added some tests from the schooltool icalendar parser for better - coverage - -* Be more forgiving on the regex for folding lines - -* Allow for multiple top-level components on .from_string - -* Fix vWeekdays, wasn't accepting relative param (eg: -3SA vs -SA) - -* vDDDTypes didn't accept negative period (eg: -P30M) - -* '\N' is also acceptable as newline on content lines, per RFC - - -iCalendar 0.10 (2005-04-28) -=========================== - -* moved code to codespeak.net subversion. - -* reorganized package structure so that source code is under 'src' - directory. Non-package files remain in distribution root. - -* redid doc/*.py files as doc/*.txt, using more modern doctest. Before - they were .py files with big docstrings. - -* added test.py testrunner, and tests/test_icalendar.py that picks up - all doctests in source code and doc directory, and runs them, when - typing: - - python2.3 test.py - -* renamed iCalendar to lower case package name, lowercased, - de-pluralized and shorted module names, which are mostly - implementation detail. - -* changed tests so they generate .ics files in a temp directory, not - in the structure itself. diff --git a/CREDITS.txt b/docs/credits.rst similarity index 63% rename from CREDITS.txt rename to docs/credits.rst index 278af75..7a0efe4 100644 --- a/CREDITS.txt +++ b/docs/credits.rst @@ -1,19 +1,10 @@ iCalendar contributors ====================== -Main developer --------------- - -- Max M (maxm@mxm.dk) - -Janitor -------- +- Max M (maxm@mxm.dk) (Original author) - Martijn Faassen (faassen@infrae.com) -Contributors ------------- - - Lennart Regebro (lregebro@nuxeo.com) - Sidnei da Silva (sidnei@enfoldsystems.com) @@ -21,5 +12,3 @@ Contributors - Olivier Grisel (ogrisel@nuxeo.com) - Michael Smith - -Thanks to codespeak for hosting this project. diff --git a/docs/index.rst b/docs/index.rst index 8ef9de5..fce36d4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,7 +8,9 @@ Contents :maxdepth: 2 about + install examples RFC 5545 changelog + credits license diff --git a/INSTALL.txt b/docs/install.rst similarity index 100% rename from INSTALL.txt rename to docs/install.rst