aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py2
-rw-r--r--docs/index.rst16
2 files changed, 16 insertions, 2 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 2914f78..a893c03 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -68,7 +68,7 @@ author = u'Lorenz Diener'
68# The short X.Y version. 68# The short X.Y version.
69version = u'1.0' 69version = u'1.0'
70# The full version, including alpha/beta/rc tags. 70# The full version, including alpha/beta/rc tags.
71release = u'1.0.0' 71release = u'1.0.1'
72 72
73# The language for content autogenerated by Sphinx. Refer to documentation 73# The language for content autogenerated by Sphinx. Refer to documentation
74# for a list of supported languages. 74# for a list of supported languages.
diff --git a/docs/index.rst b/docs/index.rst
index 6439f69..a91cfb7 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -37,8 +37,11 @@ as a single python module. By default, it talks to the
37`Mastodon flagship instance`_, but it can be set to talk to any 37`Mastodon flagship instance`_, but it can be set to talk to any
38node running Mastodon. 38node running Mastodon.
39 39
40Unless otherwise specified, all data is returned as python
41dictionaries, matching the JSON format used by the API.
40For complete documentation on what every function returns, 42For complete documentation on what every function returns,
41check the `Mastodon API docs`_, or just play around a bit. 43check the `Mastodon API docs`_, or just play around a bit - the
44format of the data is generally very easy to understand.
42 45
43.. py:module:: mastodon 46.. py:module:: mastodon
44.. py:class: Mastodon 47.. py:class: Mastodon
@@ -68,6 +71,10 @@ This function allows you to access the timelines a logged in
68user could see, as well as hashtag timelines and the public timeline. 71user could see, as well as hashtag timelines and the public timeline.
69 72
70.. automethod:: Mastodon.timeline 73.. automethod:: Mastodon.timeline
74.. automethod:: Mastodon.timeline_home
75.. automethod:: Mastodon.timeline_mentions
76.. automethod:: Mastodon.timeline_public
77.. automethod:: Mastodon.timeline_hashtag
71 78
72Reading data: Statuses 79Reading data: Statuses
73---------------------- 80----------------------
@@ -78,6 +85,13 @@ These functions allow you to get information about single statuses.
78.. automethod:: Mastodon.status_reblogged_by 85.. automethod:: Mastodon.status_reblogged_by
79.. automethod:: Mastodon.status_favourited_by 86.. automethod:: Mastodon.status_favourited_by
80 87
88Reading data: Notifications
89---------------------------
90This function allows you to get information about a users notifications.
91
92.. automethod:: Mastodon.notifications
93
94
81Reading data: Accounts 95Reading data: Accounts
82---------------------- 96----------------------
83These functions allow you to get information about accounts and 97These functions allow you to get information about accounts and
Powered by cgit v1.2.3 (git 2.41.0)