Skip to content

Commit fef097c

Browse files
MerleLiuKunMerleLiuKun
committed
docs(docs): 📝 add docs use the readthedocs.
1 parent 3a16a4d commit fef097c

5 files changed

Lines changed: 36 additions & 67 deletions

File tree

‎docs/index.rst‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,23 @@
66
Welcome to Python-Facebook's documentation!
77
===========================================
88

9-
A Python wrapper around for Facebook Common API.
9+
**A Python wrapper around for Facebook Common API.**
1010

11+
Author: IkarosKun <[email protected]>
12+
13+
Contents:
1114

1215
.. toctree::
13-
:maxdepth: 2
14-
:caption: Contents:
16+
:maxdepth: 1
1517

16-
modules.rst
18+
models.rst
1719
pyfacebook.rst
18-
pyfacebook.utils.rst
1920

21+
Introduction
22+
------------
23+
24+
This library provides a Python interface for the `Facebook Graph API <https://developers.facebook.com/docs/graph-api>`_.
25+
Library could works on Python 2.7+ and Python 3.
2026

2127

2228
Indices and tables

‎docs/models.rst‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Models
2+
======
3+
4+
Python-Facebook provides following models of the the objects returned by the API:
5+
6+
* :py:class:`pyfacebook.models.AccessToken`
7+
* :py:class:`pyfacebook.models.Cover`
8+
* :py:class:`pyfacebook.models.PageCategory`
9+
* :py:class:`pyfacebook.models.PageEngagement`
10+
* :py:class:`pyfacebook.models.Page`
11+
* :py:class:`pyfacebook.models.PagePicture`
12+
* :py:class:`pyfacebook.models.ReactionSummary`
13+
* :py:class:`pyfacebook.models.ShareSummary`
14+
* :py:class:`pyfacebook.models.Attachment`
15+
* :py:class:`pyfacebook.models.Post`
16+
* :py:class:`pyfacebook.models.Comment`
17+
* :py:class:`pyfacebook.models.CommentSummary`
18+
* :py:class:`pyfacebook.models.InstagramUser`
19+
* :py:class:`pyfacebook.models.InstagramMedia`

‎docs/modules.rst‎

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎docs/pyfacebook.rst‎

Lines changed: 6 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,26 @@
1-
pyfacebook package
1+
Modules Documentation
22
==================
33

4-
Subpackages
5-
-----------
6-
7-
.. toctree::
8-
9-
pyfacebook.utils
10-
11-
Submodules
12-
----------
13-
14-
pyfacebook.api module
15-
---------------------
4+
API
5+
------------
166

177
.. automodule:: pyfacebook.api
188
:members:
199
:undoc-members:
2010
:show-inheritance:
2111

22-
pyfacebook.error module
12+
Models
2313
-----------------------
2414

25-
.. automodule:: pyfacebook.error
26-
:members:
27-
:undoc-members:
28-
:show-inheritance:
29-
30-
pyfacebook.models module
31-
------------------------
32-
3315
.. automodule:: pyfacebook.models
3416
:members:
3517
:undoc-members:
3618
:show-inheritance:
3719

38-
pyfacebook.ratelimit module
39-
---------------------------
20+
RateLimit
21+
------------------------
4022

4123
.. automodule:: pyfacebook.ratelimit
4224
:members:
4325
:undoc-members:
4426
:show-inheritance:
45-
46-
47-
Module contents
48-
---------------
49-
50-
.. automodule:: pyfacebook
51-
:members:
52-
:undoc-members:
53-
:show-inheritance:

‎docs/pyfacebook.utils.rst‎

Lines changed: 0 additions & 22 deletions
This file was deleted.

0 commit comments

Comments
 (0)