Permalink
Browse files

Updated documentation

  • Loading branch information...
1 parent aa52a9b commit 24b847951eb1896b9172b6998a2aa6b3e08968a8 @dakrauth committed Mar 18, 2013
Showing with 3,610 additions and 1,787 deletions.
  1. +15 −15 README.md
  2. +4 −0 docs/build/html/.buildinfo
  3. +6 −0 docs/build/html/_sources/changes.txt
  4. +26 −27 docs/build/html/_sources/intro.txt
  5. BIN docs/build/html/_static/ajax-loader.gif
  6. +540 −0 docs/build/html/_static/basic.css
  7. BIN docs/build/html/_static/comment-bright.png
  8. BIN docs/build/html/_static/comment-close.png
  9. BIN docs/build/html/_static/comment.png
  10. +62 −673 docs/build/html/_static/default.css
  11. +39 −24 docs/build/html/_static/doctools.js
  12. BIN docs/build/html/_static/down-pressed.png
  13. BIN docs/build/html/_static/down.png
  14. +151 −29 docs/build/html/_static/jquery.js
  15. +62 −61 docs/build/html/_static/pygments.css
  16. +152 −53 docs/build/html/_static/searchtools.js
  17. +151 −0 docs/build/html/_static/sidebar.js
  18. +23 −0 docs/build/html/_static/underscore.js
  19. BIN docs/build/html/_static/up-pressed.png
  20. BIN docs/build/html/_static/up.png
  21. +808 −0 docs/build/html/_static/websupport.js
  22. +63 −39 docs/build/html/changes.html
  23. +149 −109 docs/build/html/forms.html
  24. +511 −198 docs/build/html/genindex.html
  25. +118 −110 docs/build/html/index.html
  26. +103 −87 docs/build/html/intro.html
  27. +153 −116 docs/build/html/models.html
  28. BIN docs/build/html/objects.inv
  29. +150 −0 docs/build/html/py-modindex.html
  30. +38 −21 docs/build/html/search.html
  31. +1 −1 docs/build/html/searchindex.js
  32. +77 −58 docs/build/html/swingtime_settings.html
  33. +108 −85 docs/build/html/utils.html
  34. +86 −67 docs/build/html/views.html
  35. +2 −2 docs/source/conf.py
  36. +12 −12 docs/source/intro.txt
View
@@ -20,35 +20,35 @@ A fairly simple example:
... description='Kiss off, Lumbergh!',
... event_type=et
... )
- >>> evt.add_occurrences(datetime(2008,12,1,16), datetime(2008,12,1,16,15), count=5)
+ >>> evt.add_occurrences(datetime(2013,4,1,16), datetime(2013,4,1,16,15), count=5)
>>> for o in evt.occurrence_set.all():
... print o
...
- New TPS Cover Sheet: 2008-12-01T16:00:00
- New TPS Cover Sheet: 2008-12-02T16:00:00
- New TPS Cover Sheet: 2008-12-03T16:00:00
- New TPS Cover Sheet: 2008-12-04T16:00:00
- New TPS Cover Sheet: 2008-12-05T16:00:00
+ New TPS Cover Sheet: 2013-04-01T16:00:00
+ New TPS Cover Sheet: 2013-04-02T16:00:00
+ New TPS Cover Sheet: 2013-04-03T16:00:00
+ New TPS Cover Sheet: 2013-04-04T16:00:00
+ New TPS Cover Sheet: 2013-04-05T16:00:00
A bit more elaborate example, using the the convenience function `create_event`:
-
+
+ >>> from dateutil import rrule
>>> # pay day is the last Friday of the month at 5pm
>>> evt = swingtime.create_event(
... 'Pay day',
... ('pay', 'Payroll'), # alternate means to add EventType on the fly
... freq=rrule.MONTHLY,
... byweekday=rrule.FR(-1),
- ... until=datetime(2009,4,1),
- ... start_time=datetime(2008,12,25,17)
+ ... until=datetime(2013,8,1),
+ ... start_time=datetime(2013,4,1,17)
... )
>>> for o in evt.occurrence_set.all():
... print o
...
- Pay day: 2008-12-26T17:00:00
- Pay day: 2009-01-30T17:00:00
- Pay day: 2009-02-27T17:00:00
- Pay day: 2009-03-27T17:00:00
-
+ Pay day: 2013-04-26T17:00:00
+ Pay day: 2013-05-31T17:00:00
+ Pay day: 2013-06-28T17:00:00
+ Pay day: 2013-07-26T17:00:00
Features
--------
@@ -59,7 +59,7 @@ Features
* Grid-based daily view generator, complete with alternating or sequential
`EventType` CSS-class handling
* Slightly better than average documentation, a few test cases, and commented code
-* Built-in demo project / application
+* **Built-in demo project / application**
Requirements
------------
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: f65864f6beef7df2ef9427179f0c226b
+tags: fbb0d17656682115ca4d033fb2f83ba1
@@ -3,6 +3,12 @@
Changes in Swingtime
====================
+Release 0.2.2 (March 16, 2013)
+------------------------------
+
+* Registered in PyPI
+* Installs with `pip`
+
Release 0.2 (Decemeber 18, 2008)
--------------------------------
@@ -5,11 +5,13 @@ Introduction
About Swingtime
===============
-Swingtime is a `Django <http://www.djangoproject.com/>`_ application similar to
-stripped down version of
-`iCal for Mac OS X <http://en.wikipedia.org/wiki/ICal>`_ or
-`Google Calendar <http://www.google.com/intl/en/googlecalendar/tour.html>`_.
-Swingtime provides an :class:`~models.Event` model that act as metadata container
+Welcome
+-------
+
+Swingtime is a `Django <http://www.djangoproject.com/>`_ application similar to
+a stripped-down version of `iCal for Mac OS X <http://en.wikipedia.org/wiki/ICal>`_
+or `Google Calendar <http://www.google.com/intl/en/googlecalendar/tour.html>`_.
+Swingtime provides a :class:`~models.Event` model that acts as metadata container
for one or more :class:`~models.Occurrence` objects, which describe specific
start and end times.
@@ -27,15 +29,15 @@ A fairly simple example::
... description='Kiss off, Lumbergh!',
... event_type=et
... )
- >>> evt.add_occurrences(datetime(2008,12,1,16), datetime(2008,12,1,16,15), count=5)
+ >>> evt.add_occurrences(datetime(2013,4,1,16), datetime(2013,4,1,16,15), count=5)
>>> for o in evt.occurrence_set.all():
... print o
...
- TPM Report: 2008-12-01T16:00:00
- TPM Report: 2008-12-02T16:00:00
- TPM Report: 2008-12-03T16:00:00
- TPM Report: 2008-12-04T16:00:00
- TPM Report: 2008-12-05T16:00:00
+ New TPS Cover Sheet: 2013-04-01T16:00:00
+ New TPS Cover Sheet: 2013-04-02T16:00:00
+ New TPS Cover Sheet: 2013-04-03T16:00:00
+ New TPS Cover Sheet: 2013-04-04T16:00:00
+ New TPS Cover Sheet: 2013-04-05T16:00:00
A bit more elaborate example, using the the convenience function :func:`models.create_event`::
@@ -45,16 +47,16 @@ A bit more elaborate example, using the the convenience function :func:`models.c
... ('pay', 'Payroll'), # alternate means to add EventType on the fly
... freq=rrule.MONTHLY,
... byweekday=rrule.FR(-1),
- ... until=datetime(2009,4,1),
- ... start_time=datetime(2008,12,25,17)
+ ... until=datetime(2013,8,1),
+ ... start_time=datetime(2013,4,1,17)
... )
>>> for o in evt.occurrence_set.all():
... print o
...
- Pay day: 2008-12-26T17:00:00
- Pay day: 2009-01-30T17:00:00
- Pay day: 2009-02-27T17:00:00
- Pay day: 2009-03-27T17:00:00
+ Pay day: 2013-04-26T17:00:00
+ Pay day: 2013-05-31T17:00:00
+ Pay day: 2013-06-28T17:00:00
+ Pay day: 2013-07-26T17:00:00
Features
@@ -72,20 +74,17 @@ Features
Requirements
------------
-* `Django 1.0+ <http://www.djangoproject.com/download/>`_
-* Python 2.5+ (yeah, sorry, Swingtime won't work with 2.3 or 2.4, but I use
- 2.5+ exclusively; however, should anyone like to contribute the necessary
- backward compatible patches that don't hamstring any of 2.5+ features, I
- more than willing to include them).
+* `Django 1.4+ <http://www.djangoproject.com/download/>`_
+* Python 2.7
* The ``dateutil`` `package <http://labix.org/python-dateutil>`_.
Get Swingtime
-------------
Options:
-* `Swingtime source code <http://code.google.com/p/django-swingtime/source/checkout>`_
-* `Gzipped tarball <http://code.google.com/p/django-swingtime/downloads/list>`_
+* `Swingtime source code <https://github.com/dakrauth/django-swingtime>`_
+* ``pip install django-swingtime``
Settings
--------
@@ -108,8 +107,8 @@ Swingtime comes with its own demo project and application. The demo is themed as
a Karate studio's website and allows you see and interact with the Swingtime
application.
-A live demo can be found at http://swingtime.gorgeofeternalperil.com or run
-locally using the `built-in Django development server <http://docs.djangoproject.com/en/dev/ref/django-admin/#runserver-optional-port-number-or-ipaddr-port>`_.
+Run locally using the `built-in Django development server
+<http://docs.djangoproject.com/en/dev/ref/django-admin/#runserver-optional-port-number-or-ipaddr-port>`_.
Templates
---------
@@ -139,7 +138,7 @@ latest version tarball, you run the demo from anywhere by changing to the
Todo List
=========
-* Add i18n support
+* Add i18n support / translation support in demo
* Include a setup installer (I'm not doing ``easy_install``!)
* Add weekly view
* Import and export .ics files
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.

0 comments on commit 24b8479

Please sign in to comment.