summaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
authorLink Mauve <linkmauve@linkmauve.fr>2021-02-03 23:23:38 +0100
committerLink Mauve <linkmauve@linkmauve.fr>2021-02-03 23:23:38 +0100
commitc486c0e8219da4cdea6988b2948ffc93cb381bec (patch)
treecc4937fd4239c9bdfd2d3634d0afa4d42ef6e3fd /docs/index.rst
parentd8dbfaa37e62b230650c14151658be448137ea0e (diff)
parentf8c39bae60d7b9125ffc5d2c90ce59147fb46785 (diff)
downloadslixmpp-c486c0e8219da4cdea6988b2948ffc93cb381bec.tar.gz
slixmpp-c486c0e8219da4cdea6988b2948ffc93cb381bec.tar.bz2
slixmpp-c486c0e8219da4cdea6988b2948ffc93cb381bec.tar.xz
slixmpp-c486c0e8219da4cdea6988b2948ffc93cb381bec.zip
Merge branch 'documentation-update' into 'master'
Documentation update See merge request poezio/slixmpp!116
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst109
1 files changed, 29 insertions, 80 deletions
diff --git a/docs/index.rst b/docs/index.rst
index a01109cd..d088e015 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -16,11 +16,6 @@ Slixmpp
**Reporting bugs**
You can report bugs at http://lab.louiz.org/poezio/slixmpp/issues.
-.. note::
- slixmpp is a friendly fork of `SleekXMPP <https://github.com/fritzy/SleekXMPP>`_
- which goal is to use asyncio instead of threads to handle networking. See
- :ref:`differences`.
-
Slixmpp is an :ref:`MIT licensed <license>` XMPP library for Python 3.7+,
Slixmpp's design goals and philosphy are:
@@ -98,94 +93,27 @@ Here's your first Slixmpp Bot:
xmpp.process()
-To read if you come from SleekXMPP
-----------------------------------
-
-.. toctree::
- :maxdepth: 1
-
- differences
- using_asyncio
-
+Documentation Index
+-------------------
-Getting Started (with Examples)
--------------------------------
-.. toctree::
- :maxdepth: 1
-
- getting_started/echobot
- getting_started/sendlogout
- getting_started/component
- getting_started/presence
- getting_started/muc
- getting_started/proxy
- getting_started/scheduler
- getting_started/iq
-
-
-Tutorials, FAQs, and How To Guides
-----------------------------------
-.. toctree::
- :maxdepth: 1
-
- xeps
- xmpp_tdg
- howto/stanzas
- create_plugin
- features
- sasl
- handlersmatchers
-
-Plugin Guides
-~~~~~~~~~~~~~
-.. toctree::
- :maxdepth: 1
-
- guide_xep_0030
-
-Slixmpp Architecture and Design
----------------------------------
-.. toctree::
- :maxdepth: 3
-
- architecture
- plugin_arch
-
-API Reference
--------------
.. toctree::
:maxdepth: 2
+ getting_started/index
+ howto/index
+ api/index
+ api/stanza/index
event_index
- api/clientxmpp
- api/componentxmpp
- api/basexmpp
- api/exceptions
- api/xmlstream/jid
- api/xmlstream/stanzabase
- api/xmlstream/handler
- api/xmlstream/matcher
- api/xmlstream/xmlstream
- api/xmlstream/tostring
+ sleekxmpp
+ architecture
Plugins
~~~~~~~
-
.. toctree::
:maxdepth: 1
api/plugins/index
-Core Stanzas
-~~~~~~~~~~~~
-.. toctree::
- :maxdepth: 2
-
- api/stanza/rootstanza
- api/stanza/message
- api/stanza/presence
- api/stanza/iq
-
Additional Info
---------------
.. toctree::
@@ -200,9 +128,30 @@ Additional Info
* :ref:`modindex`
* :ref:`search`
+
+Slixmpp Credits
+---------------
+
+**Maintainers:**
+ - Florent Le Coz (`louiz@louiz.org <xmpp:louiz@louiz.org?message>`_),
+ - Mathieu Pasquet (`mathieui@mathieui.net <xmpp:mathieui@mathieui.net?message>`_),
+ - Emmanuel Gil Peyrot (`Link mauve <xmpp:linkmauve@linkmauve.fr?message>`_)
+ - Maxime Buquet (`pep <xmpp:pep@bouah.net?message>`_)
+
+**Contributors:**
+ - Sam Whited (`Sam Whited <mailto:sam@samwhited.com>`_)
+ - Dan Sully (`Dan Sully <mailto:daniel@electricalrain.com>`_)
+ - Gasper Zejn (`Gasper Zejn <mailto:zejn@kiberpipa.org>`_)
+ - Krzysztof Kotlenga (`Krzysztof Kotlenga <mailto:pocek@users.sf.net>`_)
+ - Tsukasa Hiiragi (`Tsukasa Hiiragi <mailto:bakalolka@gmail.com>`_)
+
SleekXMPP Credits
-----------------
+Slixmpp is a friendly fork of `SleekXMPP <https://github.com/fritzy/SleekXMPP>`_
+which goal is to use asyncio instead of threads to handle networking. See
+:ref:`differences`. We are crediting SleekXMPP Authors here.
+
.. note::
Those people made SleekXMPP, so you should not bother them if
you have an issue with slixmpp. But it’s still fair to credit