jshiffer/slixmpp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add lots of missing xeps, fix some issues

Browse Source 
sphinx was unhappy with some formatting artifacts
This commit is contained in:
mathieui 2025-02-03 00:16:51 +01:00
parent bf2e006f88
commit 2db5e0199c
No known key found for this signature in database
GPG Key ID: C59F84CEEFD616E3
17 changed files with 228 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/api/plugins/index.rst
View File

@ -17,6 +17,7 @@ Plugin index
xep_0049
xep_0050
xep_0054
xep_0055
xep_0059
xep_0060
xep_0065
@ -31,6 +32,7 @@ Plugin index
xep_0085
xep_0086
xep_0092
xep_0100
xep_0106
xep_0107
xep_0108
@ -62,12 +64,15 @@ Plugin index
xep_0256
xep_0257
xep_0258
xep_0264
xep_0279
xep_0280
xep_0292
xep_0297
xep_0300
xep_0308
xep_0313
xep_0317
xep_0319
xep_0332
xep_0333
@ -79,9 +84,13 @@ Plugin index
xep_0359
xep_0363
xep_0369
xep_0372
xep_0377
xep_0380
xep_0382
xep_0385
xep_0394
xep_0402
xep_0403
xep_0404
xep_0405
@ -94,4 +103,9 @@ Plugin index
xep_0439
xep_0441
xep_0444
xep_0446
xep_0447
xep_0461
xep_0469
xep_0490
xep_0492

2
docs/api/plugins/xep_0100.rst
View File

@ -1,5 +1,5 @@
XEP-0106: Gateway interaction
XEP-0100: Gateway interaction
=============================
.. module:: slixmpp.plugins.xep_0100

18
docs/api/plugins/xep_0264.rst Normal file
View File

@ -0,0 +1,18 @@
XEP-0264: Jingle Content Thumbnails
===================================
.. module:: slixmpp.plugins.xep_0264
.. autoclass:: XEP_0264
:members:
:exclude-members: session_bind, plugin_init, plugin_end
Stanza elements
---------------
.. automodule:: slixmpp.plugins.xep_0264.stanza
:members:
:undoc-members:

18
docs/api/plugins/xep_0317.rst Normal file
View File

@ -0,0 +1,18 @@
XEP-0317: Hats
==============
.. module:: slixmpp.plugins.xep_0317
.. autoclass:: XEP_0317
:members:
:exclude-members: session_bind, plugin_init, plugin_end
Stanza elements
---------------
.. automodule:: slixmpp.plugins.xep_0317.stanza
:members:
:undoc-members:

18
docs/api/plugins/xep_0372.rst Normal file
View File

@ -0,0 +1,18 @@
XEP-0372: References
====================
.. module:: slixmpp.plugins.xep_0372
.. autoclass:: XEP_0372
:members:
:exclude-members: session_bind, plugin_init, plugin_end
Stanza elements
---------------
.. automodule:: slixmpp.plugins.xep_0372.stanza
:members:
:undoc-members:

18
docs/api/plugins/xep_0382.rst Normal file
View File

@ -0,0 +1,18 @@
XEP-0382: Spoiler Messages
==========================
.. module:: slixmpp.plugins.xep_0382
.. autoclass:: XEP_0382
:members:
:exclude-members: session_bind, plugin_init, plugin_end
Stanza elements
---------------
.. automodule:: slixmpp.plugins.xep_0382.stanza
:members:
:undoc-members:

18
docs/api/plugins/xep_0385.rst Normal file
View File

@ -0,0 +1,18 @@
XEP-0385: Stateless Inline Media Sharing (SIMS)
===============================================
.. module:: slixmpp.plugins.xep_0385
.. autoclass:: XEP_0385
:members:
:exclude-members: session_bind, plugin_init, plugin_end
Stanza elements
---------------
.. automodule:: slixmpp.plugins.xep_0385.stanza
:members:
:undoc-members:

18
docs/api/plugins/xep_0402.rst Normal file
View File

@ -0,0 +1,18 @@
XEP-0402: PEP Native Bookmarks
==============================
.. module:: slixmpp.plugins.xep_0402
.. autoclass:: XEP_0402
:members:
:exclude-members: session_bind, plugin_init, plugin_end
Stanza elements
---------------
.. automodule:: slixmpp.plugins.xep_0402.stanza
:members:
:undoc-members:

18
docs/api/plugins/xep_0446.rst Normal file
View File

@ -0,0 +1,18 @@
XEP-0446: File metadata element
===============================
.. module:: slixmpp.plugins.xep_0446
.. autoclass:: XEP_0446
:members:
:exclude-members: session_bind, plugin_init, plugin_end
Stanza elements
---------------
.. automodule:: slixmpp.plugins.xep_0446.stanza
:members:
:undoc-members:

18
docs/api/plugins/xep_0447.rst Normal file
View File

@ -0,0 +1,18 @@
XEP-0447: Stateless File Sharing
================================
.. module:: slixmpp.plugins.xep_0447
.. autoclass:: XEP_0447
:members:
:exclude-members: session_bind, plugin_init, plugin_end
Stanza elements
---------------
.. automodule:: slixmpp.plugins.xep_0447.stanza
:members:
:undoc-members:

18
docs/api/plugins/xep_0461.rst Normal file
View File

@ -0,0 +1,18 @@
XEP-0461: Message Replies
=========================
.. module:: slixmpp.plugins.xep_0461
.. autoclass:: XEP_0461
:members:
:exclude-members: session_bind, plugin_init, plugin_end
Stanza elements
---------------
.. automodule:: slixmpp.plugins.xep_0461.stanza
:members:
:undoc-members:

17
docs/api/plugins/xep_0469.rst Normal file
View File

@ -0,0 +1,17 @@
XEP-0469: Bookmark Pinning
==========================
.. module:: slixmpp.plugins.xep_0469
.. autoclass:: XEP_0469
:members:
:exclude-members: session_bind, plugin_init, plugin_end
Stanza elements
---------------
.. automodule:: slixmpp.plugins.xep_0469.stanza
:members:
:undoc-members:

18
docs/api/plugins/xep_0490.rst Normal file
View File

@ -0,0 +1,18 @@
XEP-0490: Message Displayed Synchronization
===========================================
.. module:: slixmpp.plugins.xep_0490
.. autoclass:: XEP_0490
:members:
:exclude-members: session_bind, plugin_init, plugin_end
Stanza elements
---------------
.. automodule:: slixmpp.plugins.xep_0490.stanza
:members:
:undoc-members:

2
docs/api/plugins/xep_0492.rst
View File

@ -1,6 +1,6 @@
XEP-0492: Chat Notification Settings
===========================
====================================
.. module:: slixmpp.plugins.xep_0492

1
slixmpp/plugins/xep_0292/__init__.py
View File

@ -1,5 +1,6 @@
from slixmpp.plugins.base import register_plugin
from . import stanza, vcard4
from .vcard4 import XEP_0292
register_plugin(vcard4.XEP_0292)

13
slixmpp/plugins/xep_0356/privilege.py
View File

@ -138,10 +138,10 @@ class XEP_0356(BasePlugin):
Raises ValueError if the server did not advertise the corresponding privileges
:param jid: user we want to add or modify roster items
:param roster_items: a dict containing the roster items' JIDs as keys and
nested dicts containing names, subscriptions and groups.
Example:
Here is an example of a roster_items value:
.. code-block:: json
{
"friend1@example.com": {
"name": "Friend 1",
@ -154,6 +154,11 @@ class XEP_0356(BasePlugin):
"groups": ["group3"],
},
}
:param jid: user we want to add or modify roster items
:param roster_items: a dict containing the roster items' JIDs as keys and
nested dicts containing names, subscriptions and groups.
"""
if isinstance(jid, str):
jid = JID(jid)

5
slixmpp/plugins/xep_0461/stanza.py
View File

@ -14,11 +14,12 @@ class Reply(ElementBase):
interfaces = {"id", "to"}
def add_quoted_fallback(self, fallback: str, nickname: Optional[str] = None):
"""
r"""
Add plain text fallback for clients not implementing XEP-0461.
``msg["reply"].add_quoted_fallback("Some text", "Bob")`` will
prepend "> Bob:\n> Some text\n" to the body of the message, and set the
prepend ``> Bob:\n> Some text\n`` to the body of the message, and set the
fallback_body attributes accordingly, so that clients implementing
XEP-0461 can hide the fallback text.