diff options
| author | Link Mauve <linkmauve@linkmauve.fr> | 2020-12-10 19:45:30 +0100 |
|---|---|---|
| committer | Link Mauve <linkmauve@linkmauve.fr> | 2020-12-10 19:45:30 +0100 |
| commit | 1e2d15b8f58249b31dd5882772d58add1369fc37 (patch) | |
| tree | 6d39e5fc8241884acf30b209a07ef4cabd80c323 /docs | |
| parent | d37182804102682a715df43c48a6d874835cd71a (diff) | |
| parent | 155fc58a22d631746436a81119a94c80d6ea2d2b (diff) | |
| download | slixmpp-1e2d15b8f58249b31dd5882772d58add1369fc37.tar.gz slixmpp-1e2d15b8f58249b31dd5882772d58add1369fc37.tar.bz2 slixmpp-1e2d15b8f58249b31dd5882772d58add1369fc37.tar.xz slixmpp-1e2d15b8f58249b31dd5882772d58add1369fc37.zip | |
Merge branch 'docs-event-sphinx-plugins' into 'master'
Docs: add more events, add plugins to the doc
See merge request poezio/slixmpp!84
Diffstat (limited to 'docs')
101 files changed, 1990 insertions, 212 deletions
diff --git a/docs/api/plugins/index.rst b/docs/api/plugins/index.rst new file mode 100644 index 00000000..981d22e6 --- /dev/null +++ b/docs/api/plugins/index.rst @@ -0,0 +1,96 @@ +Plugins +======= + +.. toctree:: + :maxdepth: 2 + + xep_0004 + xep_0009 + xep_0012 + xep_0013 + xep_0020 + xep_0027 + xep_0030 + xep_0033 + xep_0045 + xep_0047 + xep_0049 + xep_0050 + xep_0054 + xep_0059 + xep_0060 + xep_0065 + xep_0066 + xep_0070 + xep_0071 + xep_0077 + xep_0079 + xep_0080 + xep_0082 + xep_0084 + xep_0085 + xep_0086 + xep_0092 + xep_0106 + xep_0107 + xep_0108 + xep_0115 + xep_0118 + xep_0122 + xep_0128 + xep_0131 + xep_0133 + xep_0152 + xep_0153 + xep_0163 + xep_0172 + xep_0184 + xep_0186 + xep_0191 + xep_0196 + xep_0198 + xep_0199 + xep_0202 + xep_0203 + xep_0221 + xep_0222 + xep_0223 + xep_0224 + xep_0231 + xep_0235 + xep_0249 + xep_0256 + xep_0257 + xep_0258 + xep_0279 + xep_0280 + xep_0297 + xep_0300 + xep_0308 + xep_0313 + xep_0319 + xep_0332 + xep_0333 + xep_0334 + xep_0335 + xep_0352 + xep_0353 + xep_0359 + xep_0363 + xep_0369 + xep_0377 + xep_0380 + xep_0394 + xep_0403 + xep_0404 + xep_0405 + xep_0421 + xep_0422 + xep_0424 + xep_0425 + xep_0428 + xep_0437 + xep_0439 + xep_0444 + + diff --git a/docs/api/plugins/xep_0004.rst b/docs/api/plugins/xep_0004.rst new file mode 100644 index 00000000..d035d49a --- /dev/null +++ b/docs/api/plugins/xep_0004.rst @@ -0,0 +1,21 @@ + +XEP 0004 +======== + +.. module:: slixmpp.plugins.xep_0004 + +.. autoclass:: XEP_0004 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0004.stanza.field + :members: + :undoc-members: + +.. automodule:: slixmpp.plugins.xep_0004.stanza.form + :members: + :undoc-members: diff --git a/docs/api/plugins/xep_0009.rst b/docs/api/plugins/xep_0009.rst new file mode 100644 index 00000000..7eb2768f --- /dev/null +++ b/docs/api/plugins/xep_0009.rst @@ -0,0 +1,18 @@ + +XEP 0009 +======== + +.. module:: slixmpp.plugins.xep_0009 + +.. autoclass:: XEP_0009 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0009.stanza.RPC + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0012.rst b/docs/api/plugins/xep_0012.rst new file mode 100644 index 00000000..811ac89f --- /dev/null +++ b/docs/api/plugins/xep_0012.rst @@ -0,0 +1,18 @@ + +XEP 0012 +======== + +.. module:: slixmpp.plugins.xep_0012 + +.. autoclass:: XEP_0012 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0012.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0013.rst b/docs/api/plugins/xep_0013.rst new file mode 100644 index 00000000..2823275d --- /dev/null +++ b/docs/api/plugins/xep_0013.rst @@ -0,0 +1,18 @@ + +XEP 0013 +======== + +.. module:: slixmpp.plugins.xep_0013 + +.. autoclass:: XEP_0013 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0013.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0020.rst b/docs/api/plugins/xep_0020.rst new file mode 100644 index 00000000..257fa903 --- /dev/null +++ b/docs/api/plugins/xep_0020.rst @@ -0,0 +1,18 @@ + +XEP 0020 +======== + +.. module:: slixmpp.plugins.xep_0020 + +.. autoclass:: XEP_0020 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0020.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0027.rst b/docs/api/plugins/xep_0027.rst new file mode 100644 index 00000000..c1319d55 --- /dev/null +++ b/docs/api/plugins/xep_0027.rst @@ -0,0 +1,18 @@ + +XEP 0027 +======== + +.. module:: slixmpp.plugins.xep_0027 + +.. autoclass:: XEP_0027 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0027.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0030.rst b/docs/api/plugins/xep_0030.rst new file mode 100644 index 00000000..e71392e0 --- /dev/null +++ b/docs/api/plugins/xep_0030.rst @@ -0,0 +1,22 @@ + +XEP 0030 +======== + +.. module:: slixmpp.plugins.xep_0030 + +.. autoclass:: XEP_0030 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0030.stanza.info + :members: + :undoc-members: + +.. automodule:: slixmpp.plugins.xep_0030.stanza.items + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0033.rst b/docs/api/plugins/xep_0033.rst new file mode 100644 index 00000000..51c01085 --- /dev/null +++ b/docs/api/plugins/xep_0033.rst @@ -0,0 +1,18 @@ + +XEP 0033 +======== + +.. module:: slixmpp.plugins.xep_0033 + +.. autoclass:: XEP_0033 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0033.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0045.rst b/docs/api/plugins/xep_0045.rst new file mode 100644 index 00000000..75a3a821 --- /dev/null +++ b/docs/api/plugins/xep_0045.rst @@ -0,0 +1,18 @@ + +XEP 0045 +======== + +.. module:: slixmpp.plugins.xep_0045 + +.. autoclass:: XEP_0045 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0045.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0047.rst b/docs/api/plugins/xep_0047.rst new file mode 100644 index 00000000..38dc44cb --- /dev/null +++ b/docs/api/plugins/xep_0047.rst @@ -0,0 +1,18 @@ + +XEP 0047 +======== + +.. module:: slixmpp.plugins.xep_0047 + +.. autoclass:: XEP_0047 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0047.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0049.rst b/docs/api/plugins/xep_0049.rst new file mode 100644 index 00000000..6861c6e5 --- /dev/null +++ b/docs/api/plugins/xep_0049.rst @@ -0,0 +1,18 @@ + +XEP 0049 +======== + +.. module:: slixmpp.plugins.xep_0049 + +.. autoclass:: XEP_0049 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0049.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0050.rst b/docs/api/plugins/xep_0050.rst new file mode 100644 index 00000000..907a5891 --- /dev/null +++ b/docs/api/plugins/xep_0050.rst @@ -0,0 +1,18 @@ + +XEP 0050 +======== + +.. module:: slixmpp.plugins.xep_0050 + +.. autoclass:: XEP_0050 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0050.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0054.rst b/docs/api/plugins/xep_0054.rst new file mode 100644 index 00000000..fd193e73 --- /dev/null +++ b/docs/api/plugins/xep_0054.rst @@ -0,0 +1,18 @@ + +XEP 0054 +======== + +.. module:: slixmpp.plugins.xep_0054 + +.. autoclass:: XEP_0054 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0054.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0059.rst b/docs/api/plugins/xep_0059.rst new file mode 100644 index 00000000..ef9e283b --- /dev/null +++ b/docs/api/plugins/xep_0059.rst @@ -0,0 +1,18 @@ + +XEP 0059 +======== + +.. module:: slixmpp.plugins.xep_0059 + +.. autoclass:: XEP_0059 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0059.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0060.rst b/docs/api/plugins/xep_0060.rst new file mode 100644 index 00000000..f097a76c --- /dev/null +++ b/docs/api/plugins/xep_0060.rst @@ -0,0 +1,37 @@ + +XEP 0060 +======== + +.. module:: slixmpp.plugins.xep_0060 + +.. autoclass:: XEP_0060 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0060.stanza.base + :members: + :undoc-members: + + +.. automodule:: slixmpp.plugins.xep_0060.stanza.pubsub + :members: + :undoc-members: + + + +.. automodule:: slixmpp.plugins.xep_0060.stanza.pubsub_errors + :members: + :undoc-members: + + +.. automodule:: slixmpp.plugins.xep_0060.stanza.pubsub_owner + :members: + :undoc-members: + +.. automodule:: slixmpp.plugins.xep_0060.stanza.pubsub_event + :members: + :undoc-members: diff --git a/docs/api/plugins/xep_0065.rst b/docs/api/plugins/xep_0065.rst new file mode 100644 index 00000000..729484bc --- /dev/null +++ b/docs/api/plugins/xep_0065.rst @@ -0,0 +1,18 @@ + +XEP 0065 +======== + +.. module:: slixmpp.plugins.xep_0065 + +.. autoclass:: XEP_0065 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0065.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0066.rst b/docs/api/plugins/xep_0066.rst new file mode 100644 index 00000000..92127810 --- /dev/null +++ b/docs/api/plugins/xep_0066.rst @@ -0,0 +1,18 @@ + +XEP 0066 +======== + +.. module:: slixmpp.plugins.xep_0066 + +.. autoclass:: XEP_0066 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0066.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0070.rst b/docs/api/plugins/xep_0070.rst new file mode 100644 index 00000000..3b6c60e1 --- /dev/null +++ b/docs/api/plugins/xep_0070.rst @@ -0,0 +1,18 @@ + +XEP 0070 +======== + +.. module:: slixmpp.plugins.xep_0070 + +.. autoclass:: XEP_0070 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0070.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0071.rst b/docs/api/plugins/xep_0071.rst new file mode 100644 index 00000000..25c315d2 --- /dev/null +++ b/docs/api/plugins/xep_0071.rst @@ -0,0 +1,18 @@ + +XEP 0071 +======== + +.. module:: slixmpp.plugins.xep_0071 + +.. autoclass:: XEP_0071 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0071.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0077.rst b/docs/api/plugins/xep_0077.rst new file mode 100644 index 00000000..9659b43d --- /dev/null +++ b/docs/api/plugins/xep_0077.rst @@ -0,0 +1,18 @@ + +XEP 0077 +======== + +.. module:: slixmpp.plugins.xep_0077 + +.. autoclass:: XEP_0077 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0077.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0079.rst b/docs/api/plugins/xep_0079.rst new file mode 100644 index 00000000..f910c40f --- /dev/null +++ b/docs/api/plugins/xep_0079.rst @@ -0,0 +1,18 @@ + +XEP 0079 +======== + +.. module:: slixmpp.plugins.xep_0079 + +.. autoclass:: XEP_0079 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0079.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0080.rst b/docs/api/plugins/xep_0080.rst new file mode 100644 index 00000000..c9b89339 --- /dev/null +++ b/docs/api/plugins/xep_0080.rst @@ -0,0 +1,18 @@ + +XEP 0080 +======== + +.. module:: slixmpp.plugins.xep_0080 + +.. autoclass:: XEP_0080 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0080.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0082.rst b/docs/api/plugins/xep_0082.rst new file mode 100644 index 00000000..942cb10c --- /dev/null +++ b/docs/api/plugins/xep_0082.rst @@ -0,0 +1,9 @@ + +XEP 0082 +======== + +.. module:: slixmpp.plugins.xep_0082 + +.. autoclass:: XEP_0082 + :members: + :exclude-members: session_bind, plugin_init, plugin_end diff --git a/docs/api/plugins/xep_0084.rst b/docs/api/plugins/xep_0084.rst new file mode 100644 index 00000000..bc9a34af --- /dev/null +++ b/docs/api/plugins/xep_0084.rst @@ -0,0 +1,18 @@ + +XEP 0084 +======== + +.. module:: slixmpp.plugins.xep_0084 + +.. autoclass:: XEP_0084 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0084.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0085.rst b/docs/api/plugins/xep_0085.rst new file mode 100644 index 00000000..ef2c99bd --- /dev/null +++ b/docs/api/plugins/xep_0085.rst @@ -0,0 +1,18 @@ + +XEP 0085 +======== + +.. module:: slixmpp.plugins.xep_0085 + +.. autoclass:: XEP_0085 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0085.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0086.rst b/docs/api/plugins/xep_0086.rst new file mode 100644 index 00000000..d44c7de1 --- /dev/null +++ b/docs/api/plugins/xep_0086.rst @@ -0,0 +1,18 @@ + +XEP 0086 +======== + +.. module:: slixmpp.plugins.xep_0086 + +.. autoclass:: XEP_0086 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0086.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0092.rst b/docs/api/plugins/xep_0092.rst new file mode 100644 index 00000000..3da6f04a --- /dev/null +++ b/docs/api/plugins/xep_0092.rst @@ -0,0 +1,18 @@ + +XEP 0092 +======== + +.. module:: slixmpp.plugins.xep_0092 + +.. autoclass:: XEP_0092 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0092.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0106.rst b/docs/api/plugins/xep_0106.rst new file mode 100644 index 00000000..f93d8f88 --- /dev/null +++ b/docs/api/plugins/xep_0106.rst @@ -0,0 +1,9 @@ + +XEP 0106 +======== + +.. module:: slixmpp.plugins.xep_0106 + +.. autoclass:: XEP_0106 + :members: + :exclude-members: session_bind, plugin_init, plugin_end diff --git a/docs/api/plugins/xep_0107.rst b/docs/api/plugins/xep_0107.rst new file mode 100644 index 00000000..5fa50e64 --- /dev/null +++ b/docs/api/plugins/xep_0107.rst @@ -0,0 +1,18 @@ + +XEP 0107 +======== + +.. module:: slixmpp.plugins.xep_0107 + +.. autoclass:: XEP_0107 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0107.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0108.rst b/docs/api/plugins/xep_0108.rst new file mode 100644 index 00000000..0067cb65 --- /dev/null +++ b/docs/api/plugins/xep_0108.rst @@ -0,0 +1,18 @@ + +XEP 0108 +======== + +.. module:: slixmpp.plugins.xep_0108 + +.. autoclass:: XEP_0108 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0108.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0115.rst b/docs/api/plugins/xep_0115.rst new file mode 100644 index 00000000..90706105 --- /dev/null +++ b/docs/api/plugins/xep_0115.rst @@ -0,0 +1,18 @@ + +XEP 0115 +======== + +.. module:: slixmpp.plugins.xep_0115 + +.. autoclass:: XEP_0115 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0115.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0118.rst b/docs/api/plugins/xep_0118.rst new file mode 100644 index 00000000..7d6b0e63 --- /dev/null +++ b/docs/api/plugins/xep_0118.rst @@ -0,0 +1,18 @@ + +XEP 0118 +======== + +.. module:: slixmpp.plugins.xep_0118 + +.. autoclass:: XEP_0118 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0118.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0122.rst b/docs/api/plugins/xep_0122.rst new file mode 100644 index 00000000..909a79f5 --- /dev/null +++ b/docs/api/plugins/xep_0122.rst @@ -0,0 +1,18 @@ + +XEP 0122 +======== + +.. module:: slixmpp.plugins.xep_0122 + +.. autoclass:: XEP_0122 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0122.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0128.rst b/docs/api/plugins/xep_0128.rst new file mode 100644 index 00000000..4b0ba440 --- /dev/null +++ b/docs/api/plugins/xep_0128.rst @@ -0,0 +1,9 @@ + +XEP 0128 +======== + +.. module:: slixmpp.plugins.xep_0128 + +.. autoclass:: XEP_0128 + :members: + :exclude-members: session_bind, plugin_init, plugin_end diff --git a/docs/api/plugins/xep_0131.rst b/docs/api/plugins/xep_0131.rst new file mode 100644 index 00000000..debb4e33 --- /dev/null +++ b/docs/api/plugins/xep_0131.rst @@ -0,0 +1,18 @@ + +XEP 0131 +======== + +.. module:: slixmpp.plugins.xep_0131 + +.. autoclass:: XEP_0131 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0131.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0133.rst b/docs/api/plugins/xep_0133.rst new file mode 100644 index 00000000..d666197a --- /dev/null +++ b/docs/api/plugins/xep_0133.rst @@ -0,0 +1,9 @@ + +XEP 0133 +======== + +.. module:: slixmpp.plugins.xep_0133 + +.. autoclass:: XEP_0133 + :members: + :exclude-members: session_bind, plugin_init, plugin_end diff --git a/docs/api/plugins/xep_0152.rst b/docs/api/plugins/xep_0152.rst new file mode 100644 index 00000000..c8095635 --- /dev/null +++ b/docs/api/plugins/xep_0152.rst @@ -0,0 +1,18 @@ + +XEP 0152 +======== + +.. module:: slixmpp.plugins.xep_0152 + +.. autoclass:: XEP_0152 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0152.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0153.rst b/docs/api/plugins/xep_0153.rst new file mode 100644 index 00000000..b7daf758 --- /dev/null +++ b/docs/api/plugins/xep_0153.rst @@ -0,0 +1,18 @@ + +XEP 0153 +======== + +.. module:: slixmpp.plugins.xep_0153 + +.. autoclass:: XEP_0153 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0153.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0163.rst b/docs/api/plugins/xep_0163.rst new file mode 100644 index 00000000..0bb4bda1 --- /dev/null +++ b/docs/api/plugins/xep_0163.rst @@ -0,0 +1,9 @@ + +XEP 0163 +======== + +.. module:: slixmpp.plugins.xep_0163 + +.. autoclass:: XEP_0163 + :members: + :exclude-members: session_bind, plugin_init, plugin_end diff --git a/docs/api/plugins/xep_0172.rst b/docs/api/plugins/xep_0172.rst new file mode 100644 index 00000000..a0d29163 --- /dev/null +++ b/docs/api/plugins/xep_0172.rst @@ -0,0 +1,18 @@ + +XEP 0172 +======== + +.. module:: slixmpp.plugins.xep_0172 + +.. autoclass:: XEP_0172 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0172.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0184.rst b/docs/api/plugins/xep_0184.rst new file mode 100644 index 00000000..66e28daf --- /dev/null +++ b/docs/api/plugins/xep_0184.rst @@ -0,0 +1,18 @@ + +XEP 0184 +======== + +.. module:: slixmpp.plugins.xep_0184 + +.. autoclass:: XEP_0184 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0184.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0186.rst b/docs/api/plugins/xep_0186.rst new file mode 100644 index 00000000..5c788da3 --- /dev/null +++ b/docs/api/plugins/xep_0186.rst @@ -0,0 +1,18 @@ + +XEP 0186 +======== + +.. module:: slixmpp.plugins.xep_0186 + +.. autoclass:: XEP_0186 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0186.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0191.rst b/docs/api/plugins/xep_0191.rst new file mode 100644 index 00000000..3b767b8e --- /dev/null +++ b/docs/api/plugins/xep_0191.rst @@ -0,0 +1,18 @@ + +XEP 0191 +======== + +.. module:: slixmpp.plugins.xep_0191 + +.. autoclass:: XEP_0191 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0191.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0196.rst b/docs/api/plugins/xep_0196.rst new file mode 100644 index 00000000..8bcdd4ec --- /dev/null +++ b/docs/api/plugins/xep_0196.rst @@ -0,0 +1,18 @@ + +XEP 0196 +======== + +.. module:: slixmpp.plugins.xep_0196 + +.. autoclass:: XEP_0196 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0196.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0198.rst b/docs/api/plugins/xep_0198.rst new file mode 100644 index 00000000..ed4a4e0a --- /dev/null +++ b/docs/api/plugins/xep_0198.rst @@ -0,0 +1,18 @@ + +XEP 0198 +======== + +.. module:: slixmpp.plugins.xep_0198 + +.. autoclass:: XEP_0198 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0198.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0199.rst b/docs/api/plugins/xep_0199.rst new file mode 100644 index 00000000..19e43012 --- /dev/null +++ b/docs/api/plugins/xep_0199.rst @@ -0,0 +1,18 @@ + +XEP 0199 +======== + +.. module:: slixmpp.plugins.xep_0199 + +.. autoclass:: XEP_0199 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0199.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0202.rst b/docs/api/plugins/xep_0202.rst new file mode 100644 index 00000000..693de241 --- /dev/null +++ b/docs/api/plugins/xep_0202.rst @@ -0,0 +1,18 @@ + +XEP 0202 +======== + +.. module:: slixmpp.plugins.xep_0202 + +.. autoclass:: XEP_0202 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0202.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0203.rst b/docs/api/plugins/xep_0203.rst new file mode 100644 index 00000000..68081bf9 --- /dev/null +++ b/docs/api/plugins/xep_0203.rst @@ -0,0 +1,18 @@ + +XEP 0203 +======== + +.. module:: slixmpp.plugins.xep_0203 + +.. autoclass:: XEP_0203 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0203.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0221.rst b/docs/api/plugins/xep_0221.rst new file mode 100644 index 00000000..a419ad14 --- /dev/null +++ b/docs/api/plugins/xep_0221.rst @@ -0,0 +1,18 @@ + +XEP 0221 +======== + +.. module:: slixmpp.plugins.xep_0221 + +.. autoclass:: XEP_0221 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0221.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0222.rst b/docs/api/plugins/xep_0222.rst new file mode 100644 index 00000000..cfd097c1 --- /dev/null +++ b/docs/api/plugins/xep_0222.rst @@ -0,0 +1,9 @@ + +XEP 0222 +======== + +.. module:: slixmpp.plugins.xep_0222 + +.. autoclass:: XEP_0222 + :members: + :exclude-members: session_bind, plugin_init, plugin_end diff --git a/docs/api/plugins/xep_0223.rst b/docs/api/plugins/xep_0223.rst new file mode 100644 index 00000000..ab00b580 --- /dev/null +++ b/docs/api/plugins/xep_0223.rst @@ -0,0 +1,9 @@ + +XEP 0223 +======== + +.. module:: slixmpp.plugins.xep_0223 + +.. autoclass:: XEP_0223 + :members: + :exclude-members: session_bind, plugin_init, plugin_end diff --git a/docs/api/plugins/xep_0224.rst b/docs/api/plugins/xep_0224.rst new file mode 100644 index 00000000..91d8bf3f --- /dev/null +++ b/docs/api/plugins/xep_0224.rst @@ -0,0 +1,18 @@ + +XEP 0224 +======== + +.. module:: slixmpp.plugins.xep_0224 + +.. autoclass:: XEP_0224 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0224.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0231.rst b/docs/api/plugins/xep_0231.rst new file mode 100644 index 00000000..f27e5c8e --- /dev/null +++ b/docs/api/plugins/xep_0231.rst @@ -0,0 +1,18 @@ + +XEP 0231 +======== + +.. module:: slixmpp.plugins.xep_0231 + +.. autoclass:: XEP_0231 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0231.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0235.rst b/docs/api/plugins/xep_0235.rst new file mode 100644 index 00000000..8c115f9f --- /dev/null +++ b/docs/api/plugins/xep_0235.rst @@ -0,0 +1,18 @@ + +XEP 0235 +======== + +.. module:: slixmpp.plugins.xep_0235 + +.. autoclass:: XEP_0235 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0235.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0249.rst b/docs/api/plugins/xep_0249.rst new file mode 100644 index 00000000..73a73b94 --- /dev/null +++ b/docs/api/plugins/xep_0249.rst @@ -0,0 +1,18 @@ + +XEP 0249 +======== + +.. module:: slixmpp.plugins.xep_0249 + +.. autoclass:: XEP_0249 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0249.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0256.rst b/docs/api/plugins/xep_0256.rst new file mode 100644 index 00000000..56a7ad39 --- /dev/null +++ b/docs/api/plugins/xep_0256.rst @@ -0,0 +1,9 @@ + +XEP 0256 +======== + +.. module:: slixmpp.plugins.xep_0256 + +.. autoclass:: XEP_0256 + :members: + :exclude-members: session_bind, plugin_init, plugin_end diff --git a/docs/api/plugins/xep_0257.rst b/docs/api/plugins/xep_0257.rst new file mode 100644 index 00000000..9d4e0f55 --- /dev/null +++ b/docs/api/plugins/xep_0257.rst @@ -0,0 +1,18 @@ + +XEP 0257 +======== + +.. module:: slixmpp.plugins.xep_0257 + +.. autoclass:: XEP_0257 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0257.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0258.rst b/docs/api/plugins/xep_0258.rst new file mode 100644 index 00000000..0415b24c --- /dev/null +++ b/docs/api/plugins/xep_0258.rst @@ -0,0 +1,18 @@ + +XEP 0258 +======== + +.. module:: slixmpp.plugins.xep_0258 + +.. autoclass:: XEP_0258 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0258.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0279.rst b/docs/api/plugins/xep_0279.rst new file mode 100644 index 00000000..a9846073 --- /dev/null +++ b/docs/api/plugins/xep_0279.rst @@ -0,0 +1,18 @@ + +XEP 0279 +======== + +.. module:: slixmpp.plugins.xep_0279 + +.. autoclass:: XEP_0279 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0279.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0280.rst b/docs/api/plugins/xep_0280.rst new file mode 100644 index 00000000..48412a00 --- /dev/null +++ b/docs/api/plugins/xep_0280.rst @@ -0,0 +1,18 @@ + +XEP 0280 +======== + +.. module:: slixmpp.plugins.xep_0280 + +.. autoclass:: XEP_0280 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0280.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0297.rst b/docs/api/plugins/xep_0297.rst new file mode 100644 index 00000000..763550c8 --- /dev/null +++ b/docs/api/plugins/xep_0297.rst @@ -0,0 +1,18 @@ + +XEP 0297 +======== + +.. module:: slixmpp.plugins.xep_0297 + +.. autoclass:: XEP_0297 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0297.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0300.rst b/docs/api/plugins/xep_0300.rst new file mode 100644 index 00000000..95e1b0a0 --- /dev/null +++ b/docs/api/plugins/xep_0300.rst @@ -0,0 +1,18 @@ + +XEP 0300 +======== + +.. module:: slixmpp.plugins.xep_0300 + +.. autoclass:: XEP_0300 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0300.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0308.rst b/docs/api/plugins/xep_0308.rst new file mode 100644 index 00000000..646cb3af --- /dev/null +++ b/docs/api/plugins/xep_0308.rst @@ -0,0 +1,18 @@ + +XEP 0308 +======== + +.. module:: slixmpp.plugins.xep_0308 + +.. autoclass:: XEP_0308 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0308.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0313.rst b/docs/api/plugins/xep_0313.rst new file mode 100644 index 00000000..7a70101f --- /dev/null +++ b/docs/api/plugins/xep_0313.rst @@ -0,0 +1,18 @@ + +XEP 0313 +======== + +.. module:: slixmpp.plugins.xep_0313 + +.. autoclass:: XEP_0313 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0313.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0319.rst b/docs/api/plugins/xep_0319.rst new file mode 100644 index 00000000..dadd1150 --- /dev/null +++ b/docs/api/plugins/xep_0319.rst @@ -0,0 +1,18 @@ + +XEP 0319 +======== + +.. module:: slixmpp.plugins.xep_0319 + +.. autoclass:: XEP_0319 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0319.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0332.rst b/docs/api/plugins/xep_0332.rst new file mode 100644 index 00000000..d30019f6 --- /dev/null +++ b/docs/api/plugins/xep_0332.rst @@ -0,0 +1,26 @@ + +XEP 0332 +======== + +.. module:: slixmpp.plugins.xep_0332 + +.. autoclass:: XEP_0332 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0332.stanza.data + :members: + :undoc-members: + +.. automodule:: slixmpp.plugins.xep_0332.stanza.request + :members: + :undoc-members: + +.. automodule:: slixmpp.plugins.xep_0332.stanza.response + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0333.rst b/docs/api/plugins/xep_0333.rst new file mode 100644 index 00000000..be4ee87d --- /dev/null +++ b/docs/api/plugins/xep_0333.rst @@ -0,0 +1,18 @@ + +XEP 0333 +======== + +.. module:: slixmpp.plugins.xep_0333 + +.. autoclass:: XEP_0333 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0333.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0334.rst b/docs/api/plugins/xep_0334.rst new file mode 100644 index 00000000..0473814c --- /dev/null +++ b/docs/api/plugins/xep_0334.rst @@ -0,0 +1,18 @@ + +XEP 0334 +======== + +.. module:: slixmpp.plugins.xep_0334 + +.. autoclass:: XEP_0334 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0334.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0335.rst b/docs/api/plugins/xep_0335.rst new file mode 100644 index 00000000..32c5ce69 --- /dev/null +++ b/docs/api/plugins/xep_0335.rst @@ -0,0 +1,18 @@ + +XEP 0335 +======== + +.. module:: slixmpp.plugins.xep_0335 + +.. autoclass:: XEP_0335 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0335.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0352.rst b/docs/api/plugins/xep_0352.rst new file mode 100644 index 00000000..d7d2753c --- /dev/null +++ b/docs/api/plugins/xep_0352.rst @@ -0,0 +1,18 @@ + +XEP 0352 +======== + +.. module:: slixmpp.plugins.xep_0352 + +.. autoclass:: XEP_0352 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0352.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0353.rst b/docs/api/plugins/xep_0353.rst new file mode 100644 index 00000000..e5475f38 --- /dev/null +++ b/docs/api/plugins/xep_0353.rst @@ -0,0 +1,18 @@ + +XEP 0353 +======== + +.. module:: slixmpp.plugins.xep_0353 + +.. autoclass:: XEP_0353 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0353.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0359.rst b/docs/api/plugins/xep_0359.rst new file mode 100644 index 00000000..f996f594 --- /dev/null +++ b/docs/api/plugins/xep_0359.rst @@ -0,0 +1,18 @@ + +XEP 0359 +======== + +.. module:: slixmpp.plugins.xep_0359 + +.. autoclass:: XEP_0359 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0359.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0363.rst b/docs/api/plugins/xep_0363.rst new file mode 100644 index 00000000..ec94e721 --- /dev/null +++ b/docs/api/plugins/xep_0363.rst @@ -0,0 +1,18 @@ + +XEP 0363 +======== + +.. module:: slixmpp.plugins.xep_0363 + +.. autoclass:: XEP_0363 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0363.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0369.rst b/docs/api/plugins/xep_0369.rst new file mode 100644 index 00000000..2e457883 --- /dev/null +++ b/docs/api/plugins/xep_0369.rst @@ -0,0 +1,18 @@ + +XEP 0369 +======== + +.. module:: slixmpp.plugins.xep_0369 + +.. autoclass:: XEP_0369 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0369.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0377.rst b/docs/api/plugins/xep_0377.rst new file mode 100644 index 00000000..e897fc31 --- /dev/null +++ b/docs/api/plugins/xep_0377.rst @@ -0,0 +1,18 @@ + +XEP 0377 +======== + +.. module:: slixmpp.plugins.xep_0377 + +.. autoclass:: XEP_0377 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0377.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0380.rst b/docs/api/plugins/xep_0380.rst new file mode 100644 index 00000000..b1722365 --- /dev/null +++ b/docs/api/plugins/xep_0380.rst @@ -0,0 +1,18 @@ + +XEP 0380 +======== + +.. module:: slixmpp.plugins.xep_0380 + +.. autoclass:: XEP_0380 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0380.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0394.rst b/docs/api/plugins/xep_0394.rst new file mode 100644 index 00000000..8a3f96d8 --- /dev/null +++ b/docs/api/plugins/xep_0394.rst @@ -0,0 +1,18 @@ + +XEP 0394 +======== + +.. module:: slixmpp.plugins.xep_0394 + +.. autoclass:: XEP_0394 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0394.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0403.rst b/docs/api/plugins/xep_0403.rst new file mode 100644 index 00000000..8e35bda1 --- /dev/null +++ b/docs/api/plugins/xep_0403.rst @@ -0,0 +1,18 @@ + +XEP 0403 +======== + +.. module:: slixmpp.plugins.xep_0403 + +.. autoclass:: XEP_0403 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0403.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0404.rst b/docs/api/plugins/xep_0404.rst new file mode 100644 index 00000000..bfb99d06 --- /dev/null +++ b/docs/api/plugins/xep_0404.rst @@ -0,0 +1,18 @@ + +XEP 0404 +======== + +.. module:: slixmpp.plugins.xep_0404 + +.. autoclass:: XEP_0404 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0404.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0405.rst b/docs/api/plugins/xep_0405.rst new file mode 100644 index 00000000..a2795edc --- /dev/null +++ b/docs/api/plugins/xep_0405.rst @@ -0,0 +1,18 @@ + +XEP 0405 +======== + +.. module:: slixmpp.plugins.xep_0405 + +.. autoclass:: XEP_0405 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0405.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0421.rst b/docs/api/plugins/xep_0421.rst new file mode 100644 index 00000000..0e3e534d --- /dev/null +++ b/docs/api/plugins/xep_0421.rst @@ -0,0 +1,18 @@ + +XEP 0421 +======== + +.. module:: slixmpp.plugins.xep_0421 + +.. autoclass:: XEP_0421 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0421.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0422.rst b/docs/api/plugins/xep_0422.rst new file mode 100644 index 00000000..f4839b23 --- /dev/null +++ b/docs/api/plugins/xep_0422.rst @@ -0,0 +1,18 @@ + +XEP 0422 +======== + +.. module:: slixmpp.plugins.xep_0422 + +.. autoclass:: XEP_0422 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0422.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0424.rst b/docs/api/plugins/xep_0424.rst new file mode 100644 index 00000000..2cb14364 --- /dev/null +++ b/docs/api/plugins/xep_0424.rst @@ -0,0 +1,18 @@ + +XEP 0424 +======== + +.. module:: slixmpp.plugins.xep_0424 + +.. autoclass:: XEP_0424 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0424.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0425.rst b/docs/api/plugins/xep_0425.rst new file mode 100644 index 00000000..c2fd8968 --- /dev/null +++ b/docs/api/plugins/xep_0425.rst @@ -0,0 +1,18 @@ + +XEP 0425 +======== + +.. module:: slixmpp.plugins.xep_0425 + +.. autoclass:: XEP_0425 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0425.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0428.rst b/docs/api/plugins/xep_0428.rst new file mode 100644 index 00000000..8e2a70b6 --- /dev/null +++ b/docs/api/plugins/xep_0428.rst @@ -0,0 +1,18 @@ + +XEP 0428 +======== + +.. module:: slixmpp.plugins.xep_0428 + +.. autoclass:: XEP_0428 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0428.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0437.rst b/docs/api/plugins/xep_0437.rst new file mode 100644 index 00000000..7a6d49d3 --- /dev/null +++ b/docs/api/plugins/xep_0437.rst @@ -0,0 +1,18 @@ + +XEP 0437 +======== + +.. module:: slixmpp.plugins.xep_0437 + +.. autoclass:: XEP_0437 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0437.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0439.rst b/docs/api/plugins/xep_0439.rst new file mode 100644 index 00000000..1e3aaa52 --- /dev/null +++ b/docs/api/plugins/xep_0439.rst @@ -0,0 +1,18 @@ + +XEP 0439 +======== + +.. module:: slixmpp.plugins.xep_0439 + +.. autoclass:: XEP_0439 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0439.stanza + :members: + :undoc-members: + diff --git a/docs/api/plugins/xep_0444.rst b/docs/api/plugins/xep_0444.rst new file mode 100644 index 00000000..d984843f --- /dev/null +++ b/docs/api/plugins/xep_0444.rst @@ -0,0 +1,18 @@ + +XEP 0444 +======== + +.. module:: slixmpp.plugins.xep_0444 + +.. autoclass:: XEP_0444 + :members: + :exclude-members: session_bind, plugin_init, plugin_end + + +Stanza elements +--------------- + +.. automodule:: slixmpp.plugins.xep_0444.stanza + :members: + :undoc-members: + diff --git a/docs/api/stanza/iq.rst b/docs/api/stanza/iq.rst index 0a7d7ffb..e1e9a89f 100644 --- a/docs/api/stanza/iq.rst +++ b/docs/api/stanza/iq.rst @@ -2,6 +2,7 @@ IQ Stanza ========= .. module:: slixmpp.stanza + :noindex: .. autoclass:: Iq :members: diff --git a/docs/api/stanza/message.rst b/docs/api/stanza/message.rst index f01c62a7..3292ca08 100644 --- a/docs/api/stanza/message.rst +++ b/docs/api/stanza/message.rst @@ -2,6 +2,7 @@ Message Stanza ============== .. module:: slixmpp.stanza + :noindex: .. autoclass:: Message :members: diff --git a/docs/api/xmlstream/tostring.rst b/docs/api/xmlstream/tostring.rst index 107e97b0..dae2906b 100644 --- a/docs/api/xmlstream/tostring.rst +++ b/docs/api/xmlstream/tostring.rst @@ -1,4 +1,5 @@ .. module:: slixmpp.xmlstream.tostring + :noindex: .. _tostring: diff --git a/docs/conf.py b/docs/conf.py index 208c0cdf..d9397495 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -30,7 +30,11 @@ release = ".".join(version.split(".")[0:2]) # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'sphinx.ext.intersphinx'] +extensions = [ + 'sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'sphinx.ext.intersphinx', + 'sphinx_autodoc_typehints', +] + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/docs/event_index.rst b/docs/event_index.rst index 28a41108..8ab18a6a 100644 --- a/docs/event_index.rst +++ b/docs/event_index.rst @@ -38,24 +38,24 @@ Event Index subscription decisions. chatstate_active - - **Data:** - - **Source:** + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0085.xep_0085` chatstate_composing - - **Data:** - - **Source:** + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0085.xep_0085` chatstate_gone - - **Data:** - - **Source:** + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0085.xep_0085` chatstate_inactive - - **Data:** - - **Source:** + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0085.xep_0085` chatstate_paused - - **Data:** - - **Source:** + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0085.xep_0085` disco_info - **Data:** :py:class:`~slixmpp.plugins.xep_0030.stanza.DiscoInfo` @@ -112,8 +112,8 @@ Event Index Signal that an unavailable presence stanza has been received from a JID. groupchat_invite - - **Data:** - - **Source:** + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0045.XEP_0045` groupchat_direct_invite - **Data:** :py:class:`~slixmpp.Message` @@ -172,20 +172,20 @@ Event Index Triggered whenever a data form is received inside a message. muc::[room]::got_offline - - **Data:** - - **Source:** + - **Data:** :py:class:`~slixmpp.Presence` + - **Source:** :py:class:`~slixmpp.plugins.xep_0045.XEP_0045` muc::[room]::got_online - - **Data:** - - **Source:** + - **Data:** :py:class:`~slixmpp.Presence` + - **Source:** :py:class:`~slixmpp.plugins.xep_0045.XEP_0045` muc::[room]::message - - **Data:** - - **Source:** + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0045.XEP_0045` muc::[room]::presence - - **Data:** - - **Source:** + - **Data:** :py:class:`~slixmpp.Presence` + - **Source:** :py:class:`~slixmpp.plugins.xep_0045.XEP_0045` presence_available - **Data:** :py:class:`~slixmpp.Presence` @@ -280,3 +280,127 @@ Event Index stream_error - **Data:** :py:class:`~slixmpp.stanza.StreamError` - **Source:** :py:class:`~slixmpp.BaseXMPP` + + reactions + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0444.XEP_0444` + + carbon_received + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0280.XEP_0280` + + carbon_sent + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0280.XEP_0280` + + marker + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0333.XEP_0333` + + marker_received + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0333.XEP_0333` + + marker_displayed + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0333.XEP_0333` + + marker_acknowledged + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0333.XEP_0333` + + attention + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0224.XEP_0224` + + message_correction + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0308.XEP_0308` + + receipt_received + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0184.XEP_0184` + + jingle_message_propose + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0353.XEP_0353` + + jingle_message_retract + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0353.XEP_0353` + + jingle_message_accept + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0353.XEP_0353` + + jingle_message_proceed + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0353.XEP_0353` + + jingle_message_reject + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0353.XEP_0353` + + room_activity + - **Data:** :py:class:`~slixmpp.Presence` + - **Source:** :py:class:`~slixmpp.plugins.xep_0437.XEP_0437` + + room_activity_bare + - **Data:** :py:class:`~slixmpp.Presence` + - **Source:** :py:class:`~slixmpp.plugins.xep_0437.XEP_0437` + + sm_enabled + - **Data:** :py:class:`~slixmpp.plugins.xep_0198.stanza.Enabled` + - **Source:** :py:class:`~slixmpp.plugins.xep_0198.XEP_0198` + + sm_disabled + - **Data:** + - **Source:** :py:class:`~slixmpp.plugins.xep_0198.XEP_0198` + + ibb_stream_start + - **Data:** :py:class:`~slixmpp.plugins.xep_0047.stream.IBBBytestream` + - **Source:** :py:class:`~slixmpp.plugins.xep_0047.XEP_0047` + + ibb_stream_end + - **Data:** :py:class:`~slixmpp.plugins.xep_0047.stream.IBBBytestream` + - **Source:** :py:class:`~slixmpp.plugins.xep_0047.XEP_0047` + + ibb_stream_data + - **Data:** :py:class:`~slixmpp.plugins.xep_0047.stream.IBBBytestream` + - **Source:** :py:class:`~slixmpp.plugins.xep_0047.XEP_0047` + + stream:[stream id]:[peer jid] + - **Data:** :py:class:`~slixmpp.plugins.xep_0047.stream.IBBBytestream` + - **Source:** :py:class:`~slixmpp.plugins.xep_0047.XEP_0047` + + command + - **Data:** :py:class:`~slixmpp.Iq` + - **Source:** :py:class:`~slixmpp.plugins.xep_0050.XEP_0050` + + command_[action] + - **Data:** :py:class:`~slixmpp.Iq` + - **Source:** :py:class:`~slixmpp.plugins.xep_0050.XEP_0050` + + pubsub_publish + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0060.XEP_0060` + + pubsub_retract + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0060.XEP_0060` + + pubsub_purge + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0060.XEP_0060` + + pubsub_delete + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0060.XEP_0060` + + pubsub_config + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0060.XEP_0060` + + pubsub_subscription + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0060.XEP_0060` diff --git a/docs/glossary.rst b/docs/glossary.rst index 435df102..8943af17 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -32,3 +32,11 @@ Glossary substanza See :term:`stanza plugin` + + interfaces + A set of keys defined on a :term:`stanza plugin`. + + stanza + An XML payload sent over the XML stream, which is the root of XMPP. + A stanza is either ``<iq/>``, ``<message/>`` or ``<presence/>``. Other + elements are called nonzas. diff --git a/docs/howto/make_plugin_extension_for_message_and_iq.pl.rst b/docs/howto/make_plugin_extension_for_message_and_iq.pl.rst index fb00cbf7..811de8b1 100644 --- a/docs/howto/make_plugin_extension_for_message_and_iq.pl.rst +++ b/docs/howto/make_plugin_extension_for_message_and_iq.pl.rst @@ -76,49 +76,49 @@ Plik zawiera prostą strukturę, która pozwoli nam zapisać dane logowania. .. code-block:: python
-#!/usr/bin/python3
-#File: /usr/bin/test_slixmpp & permissions rwx--x--x (711)
-
-import subprocess
-import time
-
-if __name__ == "__main__":
- #~ prefix = ["x-terminal-emulator", "-e"] # Osobny terminal dla kazdego klienta, może być zastąpiony inną konsolą.
- #~ prefix = ["xterm", "-e"]
- prefix = []
- #~ suffix = ["-d"] # Debug
- #~ suffix = ["-q"] # Quiet
- suffix = []
-
- sender_path = "./example/sender.py"
- sender_jid = "SENDER_JID"
- sender_password = "SENDER_PASSWORD"
-
- example_file = "./test_example_tag.xml"
-
- responder_path = "./example/responder.py"
- responder_jid = "RESPONDER_JID"
- responder_password = "RESPONDER_PASSWORD"
-
- # Remember about the executable permission. (`chmod +x ./file.py`)
- SENDER_TEST = prefix + [sender_path, "-j", sender_jid, "-p", sender_password, "-t", responder_jid, "--path", example_file] + suffix
- RESPON_TEST = prefix + [responder_path, "-j", responder_jid, "-p", responder_password] + suffix
-
- try:
- responder = subprocess.Popen(RESPON_TEST)
- sender = subprocess.Popen(SENDER_TEST)
- responder.wait()
- sender.wait()
- except:
- try:
- responder.terminate()
- except NameError:
- pass
- try:
- sender.terminate()
- except NameError:
- pass
- raise
+ #!/usr/bin/python3
+ #File: /usr/bin/test_slixmpp & permissions rwx--x--x (711)
+
+ import subprocess
+ import time
+
+ if __name__ == "__main__":
+ #~ prefix = ["x-terminal-emulator", "-e"] # Osobny terminal dla kazdego klienta, może być zastąpiony inną konsolą.
+ #~ prefix = ["xterm", "-e"]
+ prefix = []
+ #~ suffix = ["-d"] # Debug
+ #~ suffix = ["-q"] # Quiet
+ suffix = []
+
+ sender_path = "./example/sender.py"
+ sender_jid = "SENDER_JID"
+ sender_password = "SENDER_PASSWORD"
+
+ example_file = "./test_example_tag.xml"
+
+ responder_path = "./example/responder.py"
+ responder_jid = "RESPONDER_JID"
+ responder_password = "RESPONDER_PASSWORD"
+
+ # Remember about the executable permission. (`chmod +x ./file.py`)
+ SENDER_TEST = prefix + [sender_path, "-j", sender_jid, "-p", sender_password, "-t", responder_jid, "--path", example_file] + suffix
+ RESPON_TEST = prefix + [responder_path, "-j", responder_jid, "-p", responder_password] + suffix
+
+ try:
+ responder = subprocess.Popen(RESPON_TEST)
+ sender = subprocess.Popen(SENDER_TEST)
+ responder.wait()
+ sender.wait()
+ except:
+ try:
+ responder.terminate()
+ except NameError:
+ pass
+ try:
+ sender.terminate()
+ except NameError:
+ pass
+ raise
Skrypt uruchamiający powinien być dostosowany do potrzeb urzytkownika: można w nim pobierać ścieżki do projektu z linii komend (przez `'sys.argv[...]'` lub `'os.getcwd()'`), wybierać z jaką flagą mają zostać uruchomione programy oraz wiele innych. Jego należyte przygotowanie pozwoli zaoszczędzić czas i nerwy podczas późniejszych prac.
@@ -1263,49 +1263,49 @@ W poniższym kodzie zostały pozostawione oryginalne komentarze w języku angiel .. code-block:: python
-#!/usr/bin/python3
-#File: /usr/bin/test_slixmpp & permissions rwx--x--x (711)
-
-import subprocess
-import time
-
-if __name__ == "__main__":
- #~ prefix = ["x-terminal-emulator", "-e"] # Separate terminal for every client; can be replaced with other terminal
- #~ prefix = ["xterm", "-e"]
- prefix = []
- #~ suffix = ["-d"] # Debug
- #~ suffix = ["-q"] # Quiet
- suffix = []
-
- sender_path = "./example/sender.py"
- sender_jid = "SENDER_JID"
- sender_password = "SENDER_PASSWORD"
-
- example_file = "./test_example_tag.xml"
-
- responder_path = "./example/responder.py"
- responder_jid = "RESPONDER_JID"
- responder_password = "RESPONDER_PASSWORD"
-
- # Remember about the executable permission. (`chmod +x ./file.py`)
- SENDER_TEST = prefix + [sender_path, "-j", sender_jid, "-p", sender_password, "-t", responder_jid, "--path", example_file] + suffix
- RESPON_TEST = prefix + [responder_path, "-j", responder_jid, "-p", responder_password] + suffix
-
- try:
- responder = subprocess.Popen(RESPON_TEST)
- sender = subprocess.Popen(SENDER_TEST)
- responder.wait()
- sender.wait()
- except:
- try:
- responder.terminate()
- except NameError:
- pass
- try:
- sender.terminate()
- except NameError:
- pass
- raise
+ #!/usr/bin/python3
+ #File: /usr/bin/test_slixmpp & permissions rwx--x--x (711)
+
+ import subprocess
+ import time
+
+ if __name__ == "__main__":
+ #~ prefix = ["x-terminal-emulator", "-e"] # Separate terminal for every client; can be replaced with other terminal
+ #~ prefix = ["xterm", "-e"]
+ prefix = []
+ #~ suffix = ["-d"] # Debug
+ #~ suffix = ["-q"] # Quiet
+ suffix = []
+
+ sender_path = "./example/sender.py"
+ sender_jid = "SENDER_JID"
+ sender_password = "SENDER_PASSWORD"
+
+ example_file = "./test_example_tag.xml"
+
+ responder_path = "./example/responder.py"
+ responder_jid = "RESPONDER_JID"
+ responder_password = "RESPONDER_PASSWORD"
+
+ # Remember about the executable permission. (`chmod +x ./file.py`)
+ SENDER_TEST = prefix + [sender_path, "-j", sender_jid, "-p", sender_password, "-t", responder_jid, "--path", example_file] + suffix
+ RESPON_TEST = prefix + [responder_path, "-j", responder_jid, "-p", responder_password] + suffix
+
+ try:
+ responder = subprocess.Popen(RESPON_TEST)
+ sender = subprocess.Popen(SENDER_TEST)
+ responder.wait()
+ sender.wait()
+ except:
+ try:
+ responder.terminate()
+ except NameError:
+ pass
+ try:
+ sender.terminate()
+ except NameError:
+ pass
+ raise
.. code-block:: python
diff --git a/docs/howto/make_plugin_extension_for_message_and_iq.rst b/docs/howto/make_plugin_extension_for_message_and_iq.rst index 3a7784b8..54a9949c 100644 --- a/docs/howto/make_plugin_extension_for_message_and_iq.rst +++ b/docs/howto/make_plugin_extension_for_message_and_iq.rst @@ -76,49 +76,49 @@ This file contains a simple structure for logging credentials: .. code-block:: python -#!/usr/bin/python3 -#File: /usr/bin/test_slixmpp & permissions rwx--x--x (711) - -import subprocess -import time - -if __name__ == "__main__": - #~ prefix = ["x-terminal-emulator", "-e"] # Separate terminal for every client; can be replaced with other terminal - #~ prefix = ["xterm", "-e"] - prefix = [] - #~ suffix = ["-d"] # Debug - #~ suffix = ["-q"] # Quiet - suffix = [] - - sender_path = "./example/sender.py" - sender_jid = "SENDER_JID" - sender_password = "SENDER_PASSWORD" - - example_file = "./test_example_tag.xml" - - responder_path = "./example/responder.py" - responder_jid = "RESPONDER_JID" - responder_password = "RESPONDER_PASSWORD" - - # Remember about the executable permission. (`chmod +x ./file.py`) - SENDER_TEST = prefix + [sender_path, "-j", sender_jid, "-p", sender_password, "-t", responder_jid, "--path", example_file] + suffix - RESPON_TEST = prefix + [responder_path, "-j", responder_jid, "-p", responder_password] + suffix - - try: - responder = subprocess.Popen(RESPON_TEST) - sender = subprocess.Popen(SENDER_TEST) - responder.wait() - sender.wait() - except: - try: - responder.terminate() - except NameError: - pass - try: - sender.terminate() - except NameError: - pass - raise + #!/usr/bin/python3 + #File: /usr/bin/test_slixmpp & permissions rwx--x--x (711) + + import subprocess + import time + + if __name__ == "__main__": + #~ prefix = ["x-terminal-emulator", "-e"] # Separate terminal for every client; can be replaced with other terminal + #~ prefix = ["xterm", "-e"] + prefix = [] + #~ suffix = ["-d"] # Debug + #~ suffix = ["-q"] # Quiet + suffix = [] + + sender_path = "./example/sender.py" + sender_jid = "SENDER_JID" + sender_password = "SENDER_PASSWORD" + + example_file = "./test_example_tag.xml" + + responder_path = "./example/responder.py" + responder_jid = "RESPONDER_JID" + responder_password = "RESPONDER_PASSWORD" + + # Remember about the executable permission. (`chmod +x ./file.py`) + SENDER_TEST = prefix + [sender_path, "-j", sender_jid, "-p", sender_password, "-t", responder_jid, "--path", example_file] + suffix + RESPON_TEST = prefix + [responder_path, "-j", responder_jid, "-p", responder_password] + suffix + + try: + responder = subprocess.Popen(RESPON_TEST) + sender = subprocess.Popen(SENDER_TEST) + responder.wait() + sender.wait() + except: + try: + responder.terminate() + except NameError: + pass + try: + sender.terminate() + except NameError: + pass + raise The launch script should be convenient in use and easy to reconfigure again. The proper preparation of it now, can help saving time in the future. Logging credentials, the project paths (from `'sys.argv[...]'` or `'os.getcwd()'`), set the parameters for the debugging purposes, mock the testing xml file and many more things can be defined inside. Whichever parameters are used, the script testing itself should be fast and effortless. The proper preparation of it now, can help saving time in the future. @@ -1260,49 +1260,49 @@ Complete code from tutorial .. code-block:: python -#!/usr/bin/python3 -#File: /usr/bin/test_slixmpp & permissions rwx--x--x (711) - -import subprocess -import time - -if __name__ == "__main__": - #~ prefix = ["x-terminal-emulator", "-e"] # Separate terminal for every client; can be replaced with other terminal - #~ prefix = ["xterm", "-e"] - prefix = [] - #~ suffix = ["-d"] # Debug - #~ suffix = ["-q"] # Quiet - suffix = [] - - sender_path = "./example/sender.py" - sender_jid = "SENDER_JID" - sender_password = "SENDER_PASSWORD" - - example_file = "./test_example_tag.xml" - - responder_path = "./example/responder.py" - responder_jid = "RESPONDER_JID" - responder_password = "RESPONDER_PASSWORD" - - # Remember about the executable permission. (`chmod +x ./file.py`) - SENDER_TEST = prefix + [sender_path, "-j", sender_jid, "-p", sender_password, "-t", responder_jid, "--path", example_file] + suffix - RESPON_TEST = prefix + [responder_path, "-j", responder_jid, "-p", responder_password] + suffix - - try: - responder = subprocess.Popen(RESPON_TEST) - sender = subprocess.Popen(SENDER_TEST) - responder.wait() - sender.wait() - except: - try: - responder.terminate() - except NameError: - pass - try: - sender.terminate() - except NameError: - pass - raise + #!/usr/bin/python3 + #File: /usr/bin/test_slixmpp & permissions rwx--x--x (711) + + import subprocess + import time + + if __name__ == "__main__": + #~ prefix = ["x-terminal-emulator", "-e"] # Separate terminal for every client; can be replaced with other terminal + #~ prefix = ["xterm", "-e"] + prefix = [] + #~ suffix = ["-d"] # Debug + #~ suffix = ["-q"] # Quiet + suffix = [] + + sender_path = "./example/sender.py" + sender_jid = "SENDER_JID" + sender_password = "SENDER_PASSWORD" + + example_file = "./test_example_tag.xml" + + responder_path = "./example/responder.py" + responder_jid = "RESPONDER_JID" + responder_password = "RESPONDER_PASSWORD" + + # Remember about the executable permission. (`chmod +x ./file.py`) + SENDER_TEST = prefix + [sender_path, "-j", sender_jid, "-p", sender_password, "-t", responder_jid, "--path", example_file] + suffix + RESPON_TEST = prefix + [responder_path, "-j", responder_jid, "-p", responder_password] + suffix + + try: + responder = subprocess.Popen(RESPON_TEST) + sender = subprocess.Popen(SENDER_TEST) + responder.wait() + sender.wait() + except: + try: + responder.terminate() + except NameError: + pass + try: + sender.terminate() + except NameError: + pass + raise .. code-block:: python diff --git a/docs/index.rst b/docs/index.rst index a18c77a7..fee237c1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -167,6 +167,7 @@ API Reference api/xmlstream/matcher api/xmlstream/xmlstream api/xmlstream/tostring + api/plugins/index Core Stanzas ~~~~~~~~~~~~ @@ -178,12 +179,6 @@ Core Stanzas api/stanza/presence api/stanza/iq -Plugins -~~~~~~~ -.. toctree:: - :maxdepth: 2 - - Additional Info --------------- .. toctree:: diff --git a/docs/license.rst b/docs/license.rst index d9505344..7b0fbc99 100644 --- a/docs/license.rst +++ b/docs/license.rst @@ -2,4 +2,5 @@ License (MIT) ============= -.. include:: ../LICENSE + +.. literalinclude:: ../LICENSE diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..1fc9d861 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +sphinx-autodoc-typehints diff --git a/docs/xmpp_tdg.rst b/docs/xmpp_tdg.rst index b14fd9e1..53194e13 100644 --- a/docs/xmpp_tdg.rst +++ b/docs/xmpp_tdg.rst @@ -38,8 +38,8 @@ Updated Code def handleIncomingMessage(self, message): self.xmpp.send_message(message["from"], message["body"]) -`View full source <http://github.com/legastero/xmpp-tdg/blob/master/code/EchoBot/EchoBot.py>`_ | -`View original code <http://github.com/remko/xmpp-tdg/blob/master/code/EchoBot/EchoBot.py>`_ +`View full source (1) <http://github.com/legastero/xmpp-tdg/blob/master/code/EchoBot/EchoBot.py>`_ | +`View original code (1) <http://github.com/remko/xmpp-tdg/blob/master/code/EchoBot/EchoBot.py>`_ Example 14-1. (Page 215) ------------------------ @@ -88,8 +88,8 @@ Updated Code for subscriberJID in self.backend.getSubscriberJIDs(message.user) : self.xmpp.send_message(subscriberJID, body, mhtml=htmlBody) -`View full source <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/Bot.py>`_ | -`View original code <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/Bot.py>`_ +`View full source (2) <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/Bot.py>`_ | +`View original code (2) <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/Bot.py>`_ Example 14-3. (Page 217) @@ -131,8 +131,8 @@ Updated Code if self.backend.getShouldMonitorPresenceFromUser(user): self.handleIncomingXMPPEvent(event) -`View full source <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/ConfigurableBot.py>`_ | -`View original code <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/ConfigurableBot.py>`_ +`View full source (3) <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/ConfigurableBot.py>`_ | +`View original code (3) <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/ConfigurableBot.py>`_ Example 14-4. (Page 220) @@ -176,8 +176,8 @@ Updated Code for subscriberJID in self.backend.getSubscriberJIDs(message.user) : self.xmpp.send_message(subscriberJID, body, mfrom=self.xmpp.jid) -`View full source <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/SimpleComponent.py>`_ | -`View original code <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/SimpleComponent.py>`_ +`View full source (4) <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/SimpleComponent.py>`_ | +`View original code (4) <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/SimpleComponent.py>`_ Example 14-6. (Page 223) @@ -195,8 +195,8 @@ implementation should work correctly. To see how to implement in-band registration as a Slixmpp plugin, see the tutorial :ref:`tutorial-create-plugin`. -`View full source <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/RegistrableComponent.py>`_ | -`View original code <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/RegistrableComponent.py>`_ +`View full source (5) <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/RegistrableComponent.py>`_ | +`View original code (5) <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/RegistrableComponent.py>`_ Example 14-7. (Page 225) ------------------------ @@ -245,5 +245,5 @@ Updated Code if contactJID == self.componentDomain : self.sendAllContactSubscriptionRequestsToUser(userJID) -`View full source <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/Component.py>`_ | -`View original code <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/Component.py>`_ +`View full source (6) <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/Component.py>`_ | +`View original code (6) <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/Component.py>`_ |