diff options
Diffstat (limited to 'docs/08_instances.rst')
-rw-r--r-- | docs/08_instances.rst | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/docs/08_instances.rst b/docs/08_instances.rst new file mode 100644 index 0000000..35b3c5d --- /dev/null +++ b/docs/08_instances.rst | |||
@@ -0,0 +1,58 @@ | |||
1 | Instance-wide data and search | ||
2 | ============================= | ||
3 | .. py:module:: mastodon | ||
4 | .. py:class: Mastodon | ||
5 | |||
6 | Instance information | ||
7 | -------------------- | ||
8 | These functions allow you to fetch information associated with the | ||
9 | current instance as well as data from the instance-wide profile directory. | ||
10 | |||
11 | .. _instance(): | ||
12 | .. automethod:: Mastodon.instance | ||
13 | .. automethod:: Mastodon.instance_activity | ||
14 | .. automethod:: Mastodon.instance_peers | ||
15 | .. automethod:: Mastodon.instance_health | ||
16 | .. automethod:: Mastodon.instance_nodeinfo | ||
17 | .. automethod:: Mastodon.instance_rules | ||
18 | |||
19 | Profile directory | ||
20 | ~~~~~~~~~~~~~~~~~ | ||
21 | .. automethod:: Mastodon.directory | ||
22 | |||
23 | Emoji | ||
24 | ~~~~~ | ||
25 | .. automethod:: Mastodon.custom_emojis | ||
26 | |||
27 | Announcements | ||
28 | ------------- | ||
29 | These functions allow you to fetch announcements, mark annoucements read and modify reactions. | ||
30 | |||
31 | Reading | ||
32 | ~~~~~~~ | ||
33 | .. automethod:: Mastodon.announcements | ||
34 | |||
35 | Writing | ||
36 | ~~~~~~~ | ||
37 | .. automethod:: Mastodon.announcement_dismiss | ||
38 | .. automethod:: Mastodon.announcement_reaction_create | ||
39 | .. automethod:: Mastodon.announcement_reaction_delete | ||
40 | |||
41 | Trends | ||
42 | ------ | ||
43 | These functions, when enabled, allow you to fetch trending tags, statuses and links. | ||
44 | |||
45 | .. _trending_tags(): | ||
46 | .. automethod:: Mastodon.trending_tags | ||
47 | .. _trending_statuses(): | ||
48 | .. automethod:: Mastodon.trending_statuses | ||
49 | .. _trending_links(): | ||
50 | .. automethod:: Mastodon.trending_links | ||
51 | .. automethod:: Mastodon.trends | ||
52 | |||
53 | Search | ||
54 | ------ | ||
55 | These functions allow you to search for users, tags and, when enabled, full text, by default within your own posts and those you have interacted with. | ||
56 | |||
57 | .. automethod:: Mastodon.search | ||
58 | .. automethod:: Mastodon.search_v2 | ||