Include missing models in auto-generated API docs
This commit is contained in:
83
docs/api.rst
83
docs/api.rst
@@ -2,32 +2,79 @@
|
||||
.. highlight:: python
|
||||
.. _api:
|
||||
|
||||
.. Note: we're using () to hide the __init__ method where relevant
|
||||
|
||||
Full API
|
||||
========
|
||||
|
||||
If you are looking for information on a specific function, class, or method, this part of the documentation is for you.
|
||||
|
||||
|
||||
.. _api_client:
|
||||
|
||||
Client
|
||||
------
|
||||
|
||||
This is the main class of `fbchat`, which contains all the methods you use to interact with Facebook.
|
||||
You can extend this class, and overwrite the events, to provide custom event handling (mainly used while listening)
|
||||
.. autoclass:: Client
|
||||
|
||||
.. autoclass:: Client(email, password, user_agent=None, max_tries=5, session_cookies=None, logging_level=logging.INFO)
|
||||
:members:
|
||||
Threads
|
||||
-------
|
||||
|
||||
|
||||
.. _api_models:
|
||||
|
||||
Models
|
||||
------
|
||||
|
||||
These models are used in various functions, both as inputs and return values.
|
||||
A good tip is to write ``from fbchat.models import *`` at the start of your source, so you can use these models freely
|
||||
|
||||
.. automodule:: fbchat.models
|
||||
:members:
|
||||
.. autoclass:: Thread()
|
||||
.. autoclass:: ThreadType(Enum)
|
||||
:undoc-members:
|
||||
.. autoclass:: Page()
|
||||
.. autoclass:: User()
|
||||
.. autoclass:: Group()
|
||||
|
||||
Messages
|
||||
--------
|
||||
|
||||
.. autoclass:: Message
|
||||
.. autoclass:: Mention
|
||||
.. autoclass:: EmojiSize(Enum)
|
||||
:undoc-members:
|
||||
.. autoclass:: MessageReaction(Enum)
|
||||
:undoc-members:
|
||||
|
||||
Exceptions
|
||||
----------
|
||||
|
||||
.. autoexception:: FBchatException()
|
||||
.. autoexception:: FBchatFacebookError()
|
||||
.. autoexception:: FBchatUserError()
|
||||
|
||||
Attachments
|
||||
-----------
|
||||
|
||||
.. autoclass:: Attachment()
|
||||
.. autoclass:: ShareAttachment()
|
||||
.. autoclass:: Sticker()
|
||||
.. autoclass:: LocationAttachment()
|
||||
.. autoclass:: LiveLocationAttachment()
|
||||
.. autoclass:: FileAttachment()
|
||||
.. autoclass:: AudioAttachment()
|
||||
.. autoclass:: ImageAttachment()
|
||||
.. autoclass:: VideoAttachment()
|
||||
.. autoclass:: ImageAttachment()
|
||||
|
||||
Miscellaneous
|
||||
-------------
|
||||
|
||||
.. autoclass:: ThreadLocation(Enum)
|
||||
:undoc-members:
|
||||
.. autoclass:: ThreadColor(Enum)
|
||||
:undoc-members:
|
||||
.. autoclass:: ActiveStatus()
|
||||
.. autoclass:: TypingStatus(Enum)
|
||||
:undoc-members:
|
||||
|
||||
.. autoclass:: QuickReply
|
||||
.. autoclass:: QuickReplyText
|
||||
.. autoclass:: QuickReplyLocation
|
||||
.. autoclass:: QuickReplyPhoneNumber
|
||||
.. autoclass:: QuickReplyEmail
|
||||
|
||||
.. autoclass:: Poll
|
||||
.. autoclass:: PollOption
|
||||
|
||||
.. autoclass:: Plan
|
||||
.. autoclass:: GuestStatus(Enum)
|
||||
:undoc-members:
|
||||
|
@@ -155,6 +155,8 @@ epub_exclude_files = ["search.html"]
|
||||
# -- Options for autodoc extension ---------------------------------------
|
||||
|
||||
autoclass_content = "both"
|
||||
autodoc_member_order = "bysource"
|
||||
autodoc_default_options = {"members": True}
|
||||
|
||||
# -- Options for intersphinx extension ---------------------------------------
|
||||
|
||||
|
Reference in New Issue
Block a user