summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMichael Twomey <michael.twomey@fieldaware.com>2014-02-27 16:43:04 +0000
committerMichael Twomey <michael.twomey@fieldaware.com>2014-02-27 16:43:04 +0000
commitabd650fad42009f635c6ebadf774f4221d54ee23 (patch)
treedd2f335547d3fca3eda39521bf2ab74f09cd88ec /docs
parent5757f8552ded426dacf9f7c64334efe2d3f58697 (diff)
downloadpyiso8601-abd650fad42009f635c6ebadf774f4221d54ee23.tar.gz
Adding API reference to docs
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst10
1 files changed, 9 insertions, 1 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 51ec271..15e6a4a 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -10,7 +10,7 @@ This module parses the most common forms of ISO 8601 date strings (e.g. 2007-01-
>>> import iso8601
>>> iso8601.parse_date("2007-01-25T12:00:00Z")
-datetime.datetime(2007, 1, 25, 12, 0, tzinfo=<iso8601.iso8601.Utc ...>)
+datetime.datetime(2007, 1, 25, 12, 0, tzinfo=<iso8601.Utc>)
>>>
This module is released under a MIT license.
@@ -66,3 +66,11 @@ To install simply use pip::
pip install iso8601
+
+API
+===
+
+.. autofunction:: iso8601.parse_date
+
+.. autoexception:: iso8601.ParseError
+