summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorLance Stout <lancestout@gmail.com>2011-11-22 15:25:02 -0800
committerLance Stout <lancestout@gmail.com>2011-11-22 15:25:02 -0800
commit6906c15e8ee20633ae0bf94fee1a99d916ceedc8 (patch)
treef933aee58924c878b3fff92823667c4ba68442fb /docs
parentff5421cefcd2f86fef362d8fd8b387f7e812cc85 (diff)
downloadslixmpp-6906c15e8ee20633ae0bf94fee1a99d916ceedc8.tar.gz
slixmpp-6906c15e8ee20633ae0bf94fee1a99d916ceedc8.tar.bz2
slixmpp-6906c15e8ee20633ae0bf94fee1a99d916ceedc8.tar.xz
slixmpp-6906c15e8ee20633ae0bf94fee1a99d916ceedc8.zip
Update docs for tostring
Diffstat (limited to 'docs')
-rw-r--r--docs/api/xmlstream/index.rst (renamed from docs/api/xmlstream.rst)1
-rw-r--r--docs/api/xmlstream/stanzabase.rst (renamed from docs/api/stanzabase.rst)2
-rw-r--r--docs/api/xmlstream/tostring.rst17
-rw-r--r--docs/index.rst14
4 files changed, 23 insertions, 11 deletions
diff --git a/docs/api/xmlstream.rst b/docs/api/xmlstream/index.rst
index 65200f66..22f9f3ff 100644
--- a/docs/api/xmlstream.rst
+++ b/docs/api/xmlstream/index.rst
@@ -10,3 +10,4 @@ xmlstream
.. toctree::
stanzabase
+ tostring
diff --git a/docs/api/stanzabase.rst b/docs/api/xmlstream/stanzabase.rst
index 5a2c9a06..afed7655 100644
--- a/docs/api/stanzabase.rst
+++ b/docs/api/xmlstream/stanzabase.rst
@@ -1,3 +1,5 @@
+.. _stanzabase:
+
==========
stanzabase
==========
diff --git a/docs/api/xmlstream/tostring.rst b/docs/api/xmlstream/tostring.rst
new file mode 100644
index 00000000..038b7876
--- /dev/null
+++ b/docs/api/xmlstream/tostring.rst
@@ -0,0 +1,17 @@
+========
+tostring
+========
+
+.. module:: sleekxmpp.xmlstream.tostring
+
+.. _tostring:
+
+XML Serialization
+-----------------
+
+.. autofunction:: tostring
+
+Escaping Special Characters
+---------------------------
+
+.. autofunction:: xml_escape
diff --git a/docs/index.rst b/docs/index.rst
index 6898b506..525a479f 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -12,16 +12,8 @@ SleekXMPP
``master`` branch, while the latest development version is in the
``develop`` branch.
- **Stable Releases**
+ **Latest Stable Release**
- `1.0 RC3 <http://github.com/fritzy/SleekXMPP/zipball/1.0-RC3>`_
- - `1.0 RC2 <http://github.com/fritzy/SleekXMPP/zipball/1.0-RC2>`_
- - `1.0 RC1 <http://github.com/fritzy/SleekXMPP/zipball/1.0-RC1>`_
- - `1.0 Beta6.1 <http://github.com/fritzy/SleekXMPP/zipball/1.0-Beta6.1>`_
- - `1.0 Beta5 <http://github.com/fritzy/SleekXMPP/zipball/1.0-Beta5>`_
- - `1.0 Beta4 <http://github.com/fritzy/SleekXMPP/zipball/1.0-Beta4>`_
- - `1.0 Beta3 <http://github.com/fritzy/SleekXMPP/zipball/1.0-Beta3>`_
- - `1.0 Beta2 <http://github.com/fritzy/SleekXMPP/zipball/1.0-Beta2>`_
- - `1.0 Beta1 <http://github.com/fritzy/SleekXMPP/zipball/1.0-Beta1>`_
**Develop Releases**
- `Latest Develop Version <http://github.com/fritzy/SleekXMPP/zipball/develop>`_
@@ -90,7 +82,7 @@ Tutorials, FAQs, and How To Guides
faq
xeps
xmpp_tdg
- create_stanzas
+ howto/stanzas
create_plugin
features
sasl
@@ -119,7 +111,7 @@ API Reference
event_index
api/clientxmpp
api/basexmpp
- api/xmlstream
+ api/xmlstream/index
Additional Info
---------------