From 2729ca19319edcc7a0d8df3e211010ccf857b211 Mon Sep 17 00:00:00 2001 From: Lorenz Diener Date: Fri, 25 Nov 2016 15:39:53 +0100 Subject: More "timeline" functions, "notifications" --- docs/conf.py | 2 +- docs/index.rst | 16 +++++++++++++++- 2 files changed, 16 insertions(+), 2 deletions(-) (limited to 'docs') 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' # The short X.Y version. version = u'1.0' # The full version, including alpha/beta/rc tags. -release = u'1.0.0' +release = u'1.0.1' # The language for content autogenerated by Sphinx. Refer to documentation # 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 `Mastodon flagship instance`_, but it can be set to talk to any node running Mastodon. +Unless otherwise specified, all data is returned as python +dictionaries, matching the JSON format used by the API. For complete documentation on what every function returns, -check the `Mastodon API docs`_, or just play around a bit. +check the `Mastodon API docs`_, or just play around a bit - the +format of the data is generally very easy to understand. .. py:module:: mastodon .. py:class: Mastodon @@ -68,6 +71,10 @@ This function allows you to access the timelines a logged in user could see, as well as hashtag timelines and the public timeline. .. automethod:: Mastodon.timeline +.. automethod:: Mastodon.timeline_home +.. automethod:: Mastodon.timeline_mentions +.. automethod:: Mastodon.timeline_public +.. automethod:: Mastodon.timeline_hashtag Reading data: Statuses ---------------------- @@ -78,6 +85,13 @@ These functions allow you to get information about single statuses. .. automethod:: Mastodon.status_reblogged_by .. automethod:: Mastodon.status_favourited_by +Reading data: Notifications +--------------------------- +This function allows you to get information about a users notifications. + +.. automethod:: Mastodon.notifications + + Reading data: Accounts ---------------------- These functions allow you to get information about accounts and -- cgit v1.2.3