Fix API docs
This commit is contained in:
70
docs/api.rst
70
docs/api.rst
@@ -1,70 +0,0 @@
|
|||||||
.. module:: fbchat
|
|
||||||
.. _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.
|
|
||||||
|
|
||||||
Client
|
|
||||||
------
|
|
||||||
|
|
||||||
.. autoclass:: Client
|
|
||||||
|
|
||||||
Threads
|
|
||||||
-------
|
|
||||||
|
|
||||||
.. autoclass:: Thread()
|
|
||||||
.. autoclass:: Page()
|
|
||||||
.. autoclass:: User()
|
|
||||||
.. autoclass:: Group()
|
|
||||||
|
|
||||||
Messages
|
|
||||||
--------
|
|
||||||
|
|
||||||
.. autoclass:: Message
|
|
||||||
.. autoclass:: Mention
|
|
||||||
.. autoclass:: EmojiSize(Enum)
|
|
||||||
:undoc-members:
|
|
||||||
|
|
||||||
Exceptions
|
|
||||||
----------
|
|
||||||
|
|
||||||
.. autoexception:: FBchatException()
|
|
||||||
.. autoexception:: FBchatFacebookError()
|
|
||||||
|
|
||||||
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:: ActiveStatus()
|
|
||||||
|
|
||||||
.. autoclass:: QuickReply
|
|
||||||
.. autoclass:: QuickReplyText
|
|
||||||
.. autoclass:: QuickReplyLocation
|
|
||||||
.. autoclass:: QuickReplyPhoneNumber
|
|
||||||
.. autoclass:: QuickReplyEmail
|
|
||||||
|
|
||||||
.. autoclass:: Poll
|
|
||||||
.. autoclass:: PollOption
|
|
||||||
|
|
||||||
.. autoclass:: Plan
|
|
||||||
.. autoclass:: GuestStatus(Enum)
|
|
||||||
:undoc-members:
|
|
13
docs/api/attachments.rst
Normal file
13
docs/api/attachments.rst
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
Attachments
|
||||||
|
===========
|
||||||
|
|
||||||
|
.. autoclass:: Attachment()
|
||||||
|
.. autoclass:: ShareAttachment()
|
||||||
|
.. autoclass:: Sticker()
|
||||||
|
.. autoclass:: LocationAttachment()
|
||||||
|
.. autoclass:: LiveLocationAttachment()
|
||||||
|
.. autoclass:: FileAttachment()
|
||||||
|
.. autoclass:: AudioAttachment()
|
||||||
|
.. autoclass:: ImageAttachment()
|
||||||
|
.. autoclass:: VideoAttachment()
|
||||||
|
.. autoclass:: ImageAttachment()
|
4
docs/api/client.rst
Normal file
4
docs/api/client.rst
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
Client
|
||||||
|
======
|
||||||
|
|
||||||
|
.. autoclass:: Client
|
4
docs/api/events.rst
Normal file
4
docs/api/events.rst
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
Events
|
||||||
|
======
|
||||||
|
|
||||||
|
.. autoclass:: Listener
|
8
docs/api/exceptions.rst
Normal file
8
docs/api/exceptions.rst
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
Exceptions
|
||||||
|
==========
|
||||||
|
|
||||||
|
.. autoexception:: FacebookError()
|
||||||
|
.. autoexception:: HTTPError()
|
||||||
|
.. autoexception:: ParseError()
|
||||||
|
.. autoexception:: ExternalError()
|
||||||
|
.. autoexception:: GraphQLError()
|
22
docs/api/index.rst
Normal file
22
docs/api/index.rst
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
.. module:: fbchat
|
||||||
|
.. _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.
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
session
|
||||||
|
client
|
||||||
|
threads
|
||||||
|
thread_data
|
||||||
|
messages
|
||||||
|
exceptions
|
||||||
|
attachments
|
||||||
|
events
|
||||||
|
misc
|
8
docs/api/messages.rst
Normal file
8
docs/api/messages.rst
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
Messages
|
||||||
|
========
|
||||||
|
|
||||||
|
.. autoclass:: Message
|
||||||
|
.. autoclass:: Mention
|
||||||
|
.. autoclass:: EmojiSize(Enum)
|
||||||
|
:undoc-members:
|
||||||
|
.. autoclass:: MessageData()
|
20
docs/api/misc.rst
Normal file
20
docs/api/misc.rst
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
Miscellaneous
|
||||||
|
=============
|
||||||
|
|
||||||
|
.. autoclass:: ThreadLocation(Enum)
|
||||||
|
:undoc-members:
|
||||||
|
.. autoclass:: ActiveStatus()
|
||||||
|
|
||||||
|
.. autoclass:: QuickReply
|
||||||
|
.. autoclass:: QuickReplyText
|
||||||
|
.. autoclass:: QuickReplyLocation
|
||||||
|
.. autoclass:: QuickReplyPhoneNumber
|
||||||
|
.. autoclass:: QuickReplyEmail
|
||||||
|
|
||||||
|
.. autoclass:: Poll
|
||||||
|
.. autoclass:: PollOption
|
||||||
|
|
||||||
|
.. autoclass:: Plan
|
||||||
|
.. autoclass:: PlanData()
|
||||||
|
.. autoclass:: GuestStatus(Enum)
|
||||||
|
:undoc-members:
|
4
docs/api/session.rst
Normal file
4
docs/api/session.rst
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
Session
|
||||||
|
=======
|
||||||
|
|
||||||
|
.. autoclass:: Session()
|
6
docs/api/thread_data.rst
Normal file
6
docs/api/thread_data.rst
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
Thread Data
|
||||||
|
===========
|
||||||
|
|
||||||
|
.. autoclass:: PageData()
|
||||||
|
.. autoclass:: UserData()
|
||||||
|
.. autoclass:: GroupData()
|
8
docs/api/threads.rst
Normal file
8
docs/api/threads.rst
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
Threads
|
||||||
|
=======
|
||||||
|
|
||||||
|
.. autoclass:: ThreadABC()
|
||||||
|
.. autoclass:: Thread
|
||||||
|
.. autoclass:: Page
|
||||||
|
.. autoclass:: User
|
||||||
|
.. autoclass:: Group
|
@@ -47,6 +47,6 @@ Overview
|
|||||||
intro
|
intro
|
||||||
examples
|
examples
|
||||||
testing
|
testing
|
||||||
api
|
api/index
|
||||||
todo
|
todo
|
||||||
faq
|
faq
|
||||||
|
Reference in New Issue
Block a user