summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorLance Stout <lancestout@gmail.com>2011-12-04 20:35:17 -0800
committerLance Stout <lancestout@gmail.com>2011-12-04 20:35:17 -0800
commit8922e2050ab3b3994e0852fa314e5bdc43809283 (patch)
treeb25f29c738cfdaad989e994d98716c84022896c8 /docs
parenta85891c611aaacbd3fdd7d4a2cff89e22409db6d (diff)
downloadslixmpp-8922e2050ab3b3994e0852fa314e5bdc43809283.tar.gz
slixmpp-8922e2050ab3b3994e0852fa314e5bdc43809283.tar.bz2
slixmpp-8922e2050ab3b3994e0852fa314e5bdc43809283.tar.xz
slixmpp-8922e2050ab3b3994e0852fa314e5bdc43809283.zip
Update the API docs for XMLStream
Diffstat (limited to 'docs')
-rw-r--r--docs/api/xmlstream/index.rst13
-rw-r--r--docs/api/xmlstream/xmlstream.rst10
-rw-r--r--docs/index.rst19
3 files changed, 29 insertions, 13 deletions
diff --git a/docs/api/xmlstream/index.rst b/docs/api/xmlstream/index.rst
deleted file mode 100644
index 22f9f3ff..00000000
--- a/docs/api/xmlstream/index.rst
+++ /dev/null
@@ -1,13 +0,0 @@
-=========
-xmlstream
-=========
-
-.. module:: sleekxmpp.xmlstream
-
-.. autoclass:: XMLStream
- :members:
-
-.. toctree::
-
- stanzabase
- tostring
diff --git a/docs/api/xmlstream/xmlstream.rst b/docs/api/xmlstream/xmlstream.rst
new file mode 100644
index 00000000..90a7a6af
--- /dev/null
+++ b/docs/api/xmlstream/xmlstream.rst
@@ -0,0 +1,10 @@
+==========
+XML Stream
+==========
+
+.. module:: sleekxmpp.xmlstream.xmlstream
+
+.. autoexception:: RestartStream
+
+.. autoclass:: XMLStream
+ :members:
diff --git a/docs/index.rst b/docs/index.rst
index 4b7a006c..625672ec 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -116,10 +116,29 @@ API Reference
api/xmlstream/stanzabase
api/xmlstream/handler
api/xmlstream/matcher
+ api/xmlstream/xmlstream
api/xmlstream/scheduler
api/xmlstream/tostring
api/xmlstream/filesocket
+Core Stanzas
+~~~~~~~~~~~~
+.. toctree::
+ :maxdepth: 2
+
+ api/stanza/rootstanza
+ api/stanza/message
+ api/stanza/presence
+ api/stanza/iq
+ api/stanza/error
+ api/stanza/stream_error
+
+Plugins
+~~~~~~~
+.. toctree::
+ :maxdepth: 2
+
+
Additional Info
---------------
.. toctree::