docs: move things around for a cleaner toctree
This commit is contained in:
parent
17f08929f9
commit
d9975aa4c0
14 changed files with 71 additions and 77 deletions
16
docs/api/index.rst
Normal file
16
docs/api/index.rst
Normal file
|
@ -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
|
11
docs/api/stanza/index.rst
Normal file
11
docs/api/stanza/index.rst
Normal file
|
@ -0,0 +1,11 @@
|
|||
|
||||
Core Stanzas
|
||||
------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
rootstanza
|
||||
message
|
||||
presence
|
||||
iq
|
15
docs/getting_started/index.rst
Normal file
15
docs/getting_started/index.rst
Normal file
|
@ -0,0 +1,15 @@
|
|||
Getting Started (with examples)
|
||||
-------------------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
echobot
|
||||
sendlogout
|
||||
component
|
||||
presence
|
||||
muc
|
||||
proxy
|
||||
scheduler
|
||||
iq
|
||||
|
13
docs/howto/index.rst
Normal file
13
docs/howto/index.rst
Normal file
|
@ -0,0 +1,13 @@
|
|||
Tutorials, FAQs, and How To Guides
|
||||
----------------------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
stanzas
|
||||
create_plugin
|
||||
features
|
||||
sasl
|
||||
handlersmatchers
|
||||
guide_xep_0030
|
||||
xmpp_tdg
|
|
@ -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::
|
||||
|
|
|
@ -1,2 +0,0 @@
|
|||
Plugin Architecture
|
||||
===================
|
8
docs/sleekxmpp.rst
Normal file
8
docs/sleekxmpp.rst
Normal file
|
@ -0,0 +1,8 @@
|
|||
Coming from SleekXMPP
|
||||
---------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
differences
|
||||
using_asyncio
|
Loading…
Reference in a new issue