diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/index.rst | 16 | ||||
| -rw-r--r-- | docs/api/stanza/index.rst | 11 | ||||
| -rw-r--r-- | docs/getting_started/index.rst | 15 | ||||
| -rw-r--r-- | docs/howto/create_plugin.rst (renamed from docs/create_plugin.rst) | 0 | ||||
| -rw-r--r-- | docs/howto/features.rst (renamed from docs/features.rst) | 0 | ||||
| -rw-r--r-- | docs/howto/guide_xep_0030.rst (renamed from docs/guide_xep_0030.rst) | 0 | ||||
| -rw-r--r-- | docs/howto/handlersmatchers.rst (renamed from docs/handlersmatchers.rst) | 0 | ||||
| -rw-r--r-- | docs/howto/index.rst | 13 | ||||
| -rw-r--r-- | docs/howto/sasl.rst (renamed from docs/sasl.rst) | 0 | ||||
| -rw-r--r-- | docs/howto/xeps.rst (renamed from docs/xeps.rst) | 0 | ||||
| -rw-r--r-- | docs/howto/xmpp_tdg.rst (renamed from docs/xmpp_tdg.rst) | 0 | ||||
| -rw-r--r-- | docs/index.rst | 83 | ||||
| -rw-r--r-- | docs/plugin_arch.rst | 2 | ||||
| -rw-r--r-- | docs/sleekxmpp.rst | 8 |
14 files changed, 71 insertions, 77 deletions
diff --git a/docs/api/index.rst b/docs/api/index.rst new file mode 100644 index 00000000..aefa0f56 --- /dev/null +++ b/docs/api/index.rst @@ -0,0 +1,16 @@ +API Reference +------------- + +.. toctree:: + :maxdepth: 3 + + clientxmpp + componentxmpp + basexmpp + exceptions + xmlstream/jid + xmlstream/stanzabase + xmlstream/handler + xmlstream/matcher + xmlstream/xmlstream + xmlstream/tostring diff --git a/docs/api/stanza/index.rst b/docs/api/stanza/index.rst new file mode 100644 index 00000000..2af0d630 --- /dev/null +++ b/docs/api/stanza/index.rst @@ -0,0 +1,11 @@ + +Core Stanzas +------------ + +.. toctree:: + :maxdepth: 2 + + rootstanza + message + presence + iq diff --git a/docs/getting_started/index.rst b/docs/getting_started/index.rst new file mode 100644 index 00000000..97c34a22 --- /dev/null +++ b/docs/getting_started/index.rst @@ -0,0 +1,15 @@ +Getting Started (with examples) +------------------------------- + +.. toctree:: + :maxdepth: 3 + + echobot + sendlogout + component + presence + muc + proxy + scheduler + iq + diff --git a/docs/create_plugin.rst b/docs/howto/create_plugin.rst index 437374c7..437374c7 100644 --- a/docs/create_plugin.rst +++ b/docs/howto/create_plugin.rst diff --git a/docs/features.rst b/docs/howto/features.rst index 4d93d5c3..4d93d5c3 100644 --- a/docs/features.rst +++ b/docs/howto/features.rst diff --git a/docs/guide_xep_0030.rst b/docs/howto/guide_xep_0030.rst index a3af4857..a3af4857 100644 --- a/docs/guide_xep_0030.rst +++ b/docs/howto/guide_xep_0030.rst diff --git a/docs/handlersmatchers.rst b/docs/howto/handlersmatchers.rst index 628c4142..628c4142 100644 --- a/docs/handlersmatchers.rst +++ b/docs/howto/handlersmatchers.rst diff --git a/docs/howto/index.rst b/docs/howto/index.rst new file mode 100644 index 00000000..b05dc499 --- /dev/null +++ b/docs/howto/index.rst @@ -0,0 +1,13 @@ +Tutorials, FAQs, and How To Guides +---------------------------------- + +.. toctree:: + :maxdepth: 2 + + stanzas + create_plugin + features + sasl + handlersmatchers + guide_xep_0030 + xmpp_tdg diff --git a/docs/sasl.rst b/docs/howto/sasl.rst index 46c45c2a..46c45c2a 100644 --- a/docs/sasl.rst +++ b/docs/howto/sasl.rst diff --git a/docs/xeps.rst b/docs/howto/xeps.rst index c5b4592d..c5b4592d 100644 --- a/docs/xeps.rst +++ b/docs/howto/xeps.rst diff --git a/docs/xmpp_tdg.rst b/docs/howto/xmpp_tdg.rst index 53194e13..53194e13 100644 --- a/docs/xmpp_tdg.rst +++ b/docs/howto/xmpp_tdg.rst diff --git a/docs/index.rst b/docs/index.rst index 1a7b2043..d088e015 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -93,94 +93,27 @@ Here's your first Slixmpp Bot: xmpp.process() -To read if you come from SleekXMPP ----------------------------------- +Documentation Index +------------------- .. toctree:: - :maxdepth: 1 - - differences - using_asyncio - - -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:: diff --git a/docs/plugin_arch.rst b/docs/plugin_arch.rst deleted file mode 100644 index 0141b793..00000000 --- a/docs/plugin_arch.rst +++ /dev/null @@ -1,2 +0,0 @@ -Plugin Architecture -=================== diff --git a/docs/sleekxmpp.rst b/docs/sleekxmpp.rst new file mode 100644 index 00000000..12f02377 --- /dev/null +++ b/docs/sleekxmpp.rst @@ -0,0 +1,8 @@ +Coming from SleekXMPP +--------------------- + +.. toctree:: + :maxdepth: 2 + + differences + using_asyncio |