summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorLance Stout <lancestout@gmail.com>2011-12-04 13:42:46 -0800
committerLance Stout <lancestout@gmail.com>2011-12-04 13:42:46 -0800
commitb9332142c93047a1e1790b920c8e732689b98fa1 (patch)
treeb9db837ee24704b2fb51b5c2294ef3f1e3327d2d /docs
parentb7b53362e1adf17fb7f1f41a003ad2139cbc1474 (diff)
downloadslixmpp-b9332142c93047a1e1790b920c8e732689b98fa1.tar.gz
slixmpp-b9332142c93047a1e1790b920c8e732689b98fa1.tar.bz2
slixmpp-b9332142c93047a1e1790b920c8e732689b98fa1.tar.xz
slixmpp-b9332142c93047a1e1790b920c8e732689b98fa1.zip
Update api docs for JID
Diffstat (limited to 'docs')
-rw-r--r--docs/api/jid.rst7
-rw-r--r--docs/conf.py2
-rw-r--r--docs/index.rst1
3 files changed, 9 insertions, 1 deletions
diff --git a/docs/api/jid.rst b/docs/api/jid.rst
new file mode 100644
index 00000000..22a2db45
--- /dev/null
+++ b/docs/api/jid.rst
@@ -0,0 +1,7 @@
+Jabber IDs (JID)
+=================
+
+.. module:: sleekxmpp.xmlstream.jid
+
+.. autoclass:: JID
+ :members:
diff --git a/docs/conf.py b/docs/conf.py
index cbebd6ce..dd83f243 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -16,7 +16,7 @@ import sys, os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('..'))
# -- General configuration -----------------------------------------------------
diff --git a/docs/index.rst b/docs/index.rst
index d5b83cbe..76c3741e 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -112,6 +112,7 @@ API Reference
api/clientxmpp
api/componentxmpp
api/basexmpp
+ api/jid
api/xmlstream/stanzabase
api/xmlstream/tostring
api/xmlstream/filesocket