Updae a bunch of docstrings

docs/02_return_values.rst

@@ -1,6 +1,7 @@
 Return values
 =============
 .. py:module:: mastodon
+   :no-index:
 .. py:class: Mastodon
 
 Unless otherwise specified, all data is returned as Python dictionaries, matching

docs/03_errors.rst

@@ -1,6 +1,7 @@
 Error handling
 ==============
 .. py:module:: mastodon
+    :no-index:
 .. py:class: Mastodon
 
 When Mastodon.py encounters an error, it will raise an exception, generally with

docs/04_auth.rst

@@ -1,6 +1,7 @@
 App registration, authentication and preferences
 ================================================
 .. py:module:: mastodon
+    :no-index:
 .. py:class: Mastodon
 
 Before you can use the Mastodon API, you have to register your
@@ -40,4 +41,5 @@ Authentication
 
 User preferences
 ----------------
-.. automethod:: Mastodon.preferences
+.. automethod:: Mastodon.preferences
+    

docs/05_statuses.rst

@@ -1,6 +1,7 @@
 Statuses, media and polls
 =========================
 .. py:module:: mastodon
+    :no-index:
 .. py:class: Mastodon
 
 Statuses
@@ -89,4 +90,5 @@ Writing
 Translation
 -----------
 These functions allow you to get machine translations for statuses, if the instance supports it.
-.. automethod:: Mastodon.status_translate
+.. automethod:: Mastodon.status_translate
+    

docs/06_accounts.rst

@@ -1,6 +1,7 @@
 Accounts, relationships and lists
 =================================
 .. py:module:: mastodon
+    :no-index:
 .. py:class: Mastodon
 
 Accounts
@@ -130,4 +131,5 @@ Reading
 Writing
 ~~~~~~~
 .. automethod:: Mastodon.tag_follow
-.. automethod:: Mastodon.tag_unfollow
+.. automethod:: Mastodon.tag_unfollow
+    

docs/07_timelines.rst

@@ -1,6 +1,7 @@
 Reading data: Timelines
 =======================
 .. py:module:: mastodon
+    :no-index:
 .. py:class: Mastodon
 
 These functions allow you to access the timelines a logged in

docs/08_instances.rst

@@ -1,6 +1,7 @@
 Instance-wide data and search
 =============================
 .. py:module:: mastodon
+    :no-index:
 .. py:class: Mastodon
 
 Instance information
@@ -66,5 +67,6 @@ Domain blocks
 
 Translation support
 -------------------
-.. authomedod:: Mastodon.instance_languages
+.. automethod:: Mastodon.instance_languages
-.. automethod:: Mastodon.instance_translation_languages
+.. automethod:: Mastodon.instance_translation_languages
+    

docs/09_notifications.rst

@@ -1,6 +1,7 @@
 Notifications and filtering
 ===========================
 .. py:module:: mastodon
+    :no-index:
 .. py:class: Mastodon
 
 Notifications
@@ -34,7 +35,7 @@ Source filtering for notifications
 These functions allow you to get information about source filters as well as to create and update filters, and
 to accept or reject notification requests for filtered notifications.
 
-.. authomedod:: Mastodon.notifications_policy
+.. automethod:: Mastodon.notifications_policy
 .. automethod:: Mastodon.update_notifications_policy
 .. automethod:: Mastodon.notification_requests
 .. automethod:: Mastodon.notification_request
@@ -137,4 +138,5 @@ Writing
 ~~~~~~~
 .. automethod:: Mastodon.filter_create
 .. automethod:: Mastodon.filter_update
-.. automethod:: Mastodon.filter_delete        
+.. automethod:: Mastodon.filter_delete        
+    

docs/10_streaming.rst

@@ -1,6 +1,7 @@
 Streaming
 =========
 .. py:module:: mastodon
+    :no-index:
 .. py:class: Mastodon
 
 These functions allow access to the streaming API. Since Mastodon v4.2.0 the support for anonymous streaming api access was dropped.
@@ -73,3 +74,4 @@ CallbackStreamListener
 ~~~~~~~~~~~~~~~~~~~~~~
 
 .. autoclass:: CallbackStreamListener
+

docs/11_misc.rst

@@ -1,6 +1,7 @@
 Misc: Markers, reports
 ======================
 .. py:module:: mastodon
+    :no-index:
 .. py:class: Mastodon
 
 Markers
@@ -33,4 +34,5 @@ Writing
 This function allows you to report a user to the instance moderators as well as to
 the users home instance.
 
-.. automethod:: Mastodon.report
+.. automethod:: Mastodon.report
+    

docs/12_utilities.rst

@@ -1,6 +1,7 @@
 Utility: Pagination and Blurhash
 ================================
 .. py:module:: mastodon
+    :no-index:
 .. py:class: Mastodon
 
 Pagination
@@ -28,4 +29,3 @@ Cache control
 Other utilities
 ---------------
 .. automethod:: Mastodon.get_approx_server_time
-.. automethod:: Mastodon.set_language

docs/13_admin.rst

@@ -1,6 +1,7 @@
 Administration and moderation
 =============================
 .. py:module:: mastodon
+    :no-index:
 .. py:class: Mastodon
 
 These functions allow you to perform moderation actions on users and generally
@@ -40,15 +41,9 @@ Reports
 .. automethod:: Mastodon.admin_report_reopen
 .. automethod:: Mastodon.admin_report_resolve
 
-Trends
-------
-.. automethod:: Mastodon.admin_trending_tags
-.. automethod:: Mastodon.admin_trending_statuses
-.. automethod:: Mastodon.admin_trending_links
-.. automethod:: Mastodon.admin_domain_blocks
-
 Federation
 ----------
+.. automethod:: Mastodon.admin_domain_blocks
 .. automethod:: Mastodon.admin_create_domain_block
 .. automethod:: Mastodon.admin_update_domain_block
 .. automethod:: Mastodon.admin_delete_domain_block

docs/14_contributing.rst

@@ -30,4 +30,4 @@ Mastodon.py has an extensive suite of tests. The purpose of these is twofold:
 * Where the official docs are unclear, verify assumptions we make about the Mastodon API and document the results
 
 The tests use pytest and pytest-vcr so that they can be ran even without a mastodon server, but new tests require
-setting up a mastodon dev server. Further documentation can be found in the "tests" directory in the repository.
+setting up a mastodon dev server. Further documentation can be found in the "tests" directory in the repository.

docs/15_everything.rst

@@ -1,189 +1,737 @@
-Every function on a huge CTRL-F-able page
+Every function on a huge CTRL-F-able page
-=========================================
+=========================================
-.. py:module:: mastodon
+.. py:module:: mastodon
-.. py:class: Mastodon
+   :no-index:
-
+.. py:class: Mastodon
+
 .. automethod:: Mastodon.retrieve_mastodon_version
+   :no-index:
 .. automethod:: Mastodon.verify_minimum_version
+   :no-index:
+.. autoclass:: mastodon.types_base.AttribAccessDict
+   :no-index:
+.. autoclass:: mastodon.types_base.PaginatableList
+   :no-index:
+.. autoclass:: mastodon.types_base.NonPaginatableList
+   :no-index:
+.. autoclass:: mastodon.types_base.MaybeSnowflakeIdType
+   :no-index:
+.. autoclass:: mastodon.types_base.IdType
+   :no-index:
+.. autoclass:: mastodon.types_base.Entity
+   :no-index:
+.. autoclass:: mastodon.types_base.EntityList
+   :no-index:
+.. autoclass:: mastodon.return_types.Account
+   :no-index:
+.. autoclass:: mastodon.return_types.AccountField
+   :no-index:
+.. autoclass:: mastodon.return_types.Role
+   :no-index:
+.. autoclass:: mastodon.return_types.CredentialAccountSource
+   :no-index:
+.. autoclass:: mastodon.return_types.Status
+   :no-index:
+.. autoclass:: mastodon.return_types.StatusEdit
+   :no-index:
+.. autoclass:: mastodon.return_types.FilterResult
+   :no-index:
+.. autoclass:: mastodon.return_types.StatusMention
+   :no-index:
+.. autoclass:: mastodon.return_types.ScheduledStatus
+   :no-index:
+.. autoclass:: mastodon.return_types.ScheduledStatusParams
+   :no-index:
+.. autoclass:: mastodon.return_types.Poll
+   :no-index:
+.. autoclass:: mastodon.return_types.PollOption
+   :no-index:
+.. autoclass:: mastodon.return_types.Conversation
+   :no-index:
+.. autoclass:: mastodon.return_types.Tag
+   :no-index:
+.. autoclass:: mastodon.return_types.TagHistory
+   :no-index:
+.. autoclass:: mastodon.return_types.CustomEmoji
+   :no-index:
+.. autoclass:: mastodon.return_types.Application
+   :no-index:
+.. autoclass:: mastodon.return_types.Relationship
+   :no-index:
+.. autoclass:: mastodon.return_types.FilterV2
+   :no-index:
+.. autoclass:: mastodon.return_types.Notification
+   :no-index:
+.. autoclass:: mastodon.return_types.Context
+   :no-index:
+.. autoclass:: mastodon.return_types.UserList
+   :no-index:
+.. autoclass:: mastodon.return_types.MediaAttachment
+   :no-index:
+.. autoclass:: mastodon.return_types.MediaAttachmentMetadataContainer
+   :no-index:
+.. autoclass:: mastodon.return_types.MediaAttachmentImageMetadata
+   :no-index:
+.. autoclass:: mastodon.return_types.MediaAttachmentVideoMetadata
+   :no-index:
+.. autoclass:: mastodon.return_types.MediaAttachmentAudioMetadata
+   :no-index:
+.. autoclass:: mastodon.return_types.MediaAttachmentFocusPoint
+   :no-index:
+.. autoclass:: mastodon.return_types.MediaAttachmentColors
+   :no-index:
+.. autoclass:: mastodon.return_types.PreviewCard
+   :no-index:
+.. autoclass:: mastodon.return_types.TrendingLinkHistory
+   :no-index:
+.. autoclass:: mastodon.return_types.PreviewCardAuthor
+   :no-index:
+.. autoclass:: mastodon.return_types.SearchV2
+   :no-index:
+.. autoclass:: mastodon.return_types.Instance
+   :no-index:
+.. autoclass:: mastodon.return_types.InstanceConfiguration
+   :no-index:
+.. autoclass:: mastodon.return_types.InstanceURLs
+   :no-index:
+.. autoclass:: mastodon.return_types.InstanceV2
+   :no-index:
+.. autoclass:: mastodon.return_types.InstanceIcon
+   :no-index:
+.. autoclass:: mastodon.return_types.InstanceConfigurationV2
+   :no-index:
+.. autoclass:: mastodon.return_types.InstanceVapidKey
+   :no-index:
+.. autoclass:: mastodon.return_types.InstanceURLsV2
+   :no-index:
+.. autoclass:: mastodon.return_types.InstanceThumbnail
+   :no-index:
+.. autoclass:: mastodon.return_types.InstanceThumbnailVersions
+   :no-index:
+.. autoclass:: mastodon.return_types.InstanceStatistics
+   :no-index:
+.. autoclass:: mastodon.return_types.InstanceUsage
+   :no-index:
+.. autoclass:: mastodon.return_types.InstanceUsageUsers
+   :no-index:
+.. autoclass:: mastodon.return_types.Rule
+   :no-index:
+.. autoclass:: mastodon.return_types.InstanceRegistrations
+   :no-index:
+.. autoclass:: mastodon.return_types.InstanceContact
+   :no-index:
+.. autoclass:: mastodon.return_types.InstanceAccountConfiguration
+   :no-index:
+.. autoclass:: mastodon.return_types.InstanceStatusConfiguration
+   :no-index:
+.. autoclass:: mastodon.return_types.InstanceTranslationConfiguration
+   :no-index:
+.. autoclass:: mastodon.return_types.InstanceMediaConfiguration
+   :no-index:
+.. autoclass:: mastodon.return_types.InstancePollConfiguration
+   :no-index:
+.. autoclass:: mastodon.return_types.Nodeinfo
+   :no-index:
+.. autoclass:: mastodon.return_types.NodeinfoSoftware
+   :no-index:
+.. autoclass:: mastodon.return_types.NodeinfoServices
+   :no-index:
+.. autoclass:: mastodon.return_types.NodeinfoUsage
+   :no-index:
+.. autoclass:: mastodon.return_types.NodeinfoUsageUsers
+   :no-index:
+.. autoclass:: mastodon.return_types.NodeinfoMetadata
+   :no-index:
+.. autoclass:: mastodon.return_types.Activity
+   :no-index:
+.. autoclass:: mastodon.return_types.Report
+   :no-index:
+.. autoclass:: mastodon.return_types.AdminReport
+   :no-index:
+.. autoclass:: mastodon.return_types.WebPushSubscription
+   :no-index:
+.. autoclass:: mastodon.return_types.WebPushSubscriptionAlerts
+   :no-index:
+.. autoclass:: mastodon.return_types.PushNotification
+   :no-index:
+.. autoclass:: mastodon.return_types.Preferences
+   :no-index:
+.. autoclass:: mastodon.return_types.FeaturedTag
+   :no-index:
+.. autoclass:: mastodon.return_types.Marker
+   :no-index:
+.. autoclass:: mastodon.return_types.Announcement
+   :no-index:
+.. autoclass:: mastodon.return_types.Reaction
+   :no-index:
+.. autoclass:: mastodon.return_types.StreamReaction
+   :no-index:
+.. autoclass:: mastodon.return_types.FamiliarFollowers
+   :no-index:
+.. autoclass:: mastodon.return_types.AdminAccount
+   :no-index:
+.. autoclass:: mastodon.return_types.AdminIp
+   :no-index:
+.. autoclass:: mastodon.return_types.AdminMeasure
+   :no-index:
+.. autoclass:: mastodon.return_types.AdminMeasureData
+   :no-index:
+.. autoclass:: mastodon.return_types.AdminDimension
+   :no-index:
+.. autoclass:: mastodon.return_types.AdminDimensionData
+   :no-index:
+.. autoclass:: mastodon.return_types.AdminRetention
+   :no-index:
+.. autoclass:: mastodon.return_types.AdminCohort
+   :no-index:
+.. autoclass:: mastodon.return_types.AdminDomainBlock
+   :no-index:
+.. autoclass:: mastodon.return_types.AdminCanonicalEmailBlock
+   :no-index:
+.. autoclass:: mastodon.return_types.AdminDomainAllow
+   :no-index:
+.. autoclass:: mastodon.return_types.AdminEmailDomainBlock
+   :no-index:
+.. autoclass:: mastodon.return_types.AdminEmailDomainBlockHistory
+   :no-index:
+.. autoclass:: mastodon.return_types.AdminIpBlock
+   :no-index:
+.. autoclass:: mastodon.return_types.DomainBlock
+   :no-index:
+.. autoclass:: mastodon.return_types.ExtendedDescription
+   :no-index:
+.. autoclass:: mastodon.return_types.FilterKeyword
+   :no-index:
+.. autoclass:: mastodon.return_types.FilterStatus
+   :no-index:
+.. autoclass:: mastodon.return_types.StatusSource
+   :no-index:
+.. autoclass:: mastodon.return_types.Suggestion
+   :no-index:
+.. autoclass:: mastodon.return_types.Translation
+   :no-index:
+.. autoclass:: mastodon.return_types.AccountCreationError
+   :no-index:
+.. autoclass:: mastodon.return_types.AccountCreationErrorDetails
+   :no-index:
+.. autoclass:: mastodon.return_types.AccountCreationErrorDetailsField
+   :no-index:
+.. autoclass:: mastodon.return_types.NotificationPolicy
+   :no-index:
+.. autoclass:: mastodon.return_types.NotificationPolicySummary
+   :no-index:
+.. autoclass:: mastodon.return_types.RelationshipSeveranceEvent
+   :no-index:
+.. autoclass:: mastodon.return_types.GroupedNotificationsResults
+   :no-index:
+.. autoclass:: mastodon.return_types.PartialAccountWithAvatar
+   :no-index:
+.. autoclass:: mastodon.return_types.NotificationGroup
+   :no-index:
+.. autoclass:: mastodon.return_types.AccountWarning
+   :no-index:
+.. autoclass:: mastodon.return_types.UnreadNotificationsCount
+   :no-index:
+.. autoclass:: mastodon.return_types.Appeal
+   :no-index:
+.. autoclass:: mastodon.return_types.NotificationRequest
+   :no-index:
+.. autoclass:: mastodon.return_types.SupportedLocale
+   :no-index:
+.. autoclass:: mastodon.return_types.Filter
+   :no-index:
+.. autoclass:: mastodon.return_types.Search
+   :no-index:
+.. autoclass:: mastodon.return_types.IdentityProof
+   :no-index:
 .. automethod:: Mastodon.create_app
+   :no-index:
 .. automethod:: Mastodon.app_verify_credentials
+   :no-index:
 .. automethod:: Mastodon.__init__
+   :no-index:
 .. automethod:: Mastodon.log_in
+   :no-index:
 .. automethod:: Mastodon.auth_request_url
+   :no-index:
 .. automethod:: Mastodon.set_language
+   :no-index:
 .. automethod:: Mastodon.revoke_access_token
+   :no-index:
 .. automethod:: Mastodon.create_account
+   :no-index:
 .. automethod:: Mastodon.email_resend_confirmation
-.. automethod:: Mastodon.preferencesStatuses, media and polls
+   :no-index:
+.. automethod:: Mastodon.preferences
+   :no-index:
 .. automethod:: Mastodon.status
+   :no-index:
 .. automethod:: Mastodon.status_context
+   :no-index:
 .. automethod:: Mastodon.status_reblogged_by
+   :no-index:
 .. automethod:: Mastodon.status_favourited_by
+   :no-index:
 .. automethod:: Mastodon.status_card
+   :no-index:
 .. automethod:: Mastodon.status_history
+   :no-index:
 .. automethod:: Mastodon.status_source
+   :no-index:
+.. automethod:: Mastodon.statuses
+   :no-index:
 .. automethod:: Mastodon.favourites
+   :no-index:
 .. automethod:: Mastodon.bookmarks
+   :no-index:
 .. automethod:: Mastodon.status_post
+   :no-index:
 .. automethod:: Mastodon.status_reply
+   :no-index:
 .. automethod:: Mastodon.toot
+   :no-index:
 .. automethod:: Mastodon.make_poll
+   :no-index:
 .. automethod:: Mastodon.status_reblog
+   :no-index:
 .. automethod:: Mastodon.status_unreblog
+   :no-index:
 .. automethod:: Mastodon.status_favourite
+   :no-index:
 .. automethod:: Mastodon.status_unfavourite
+   :no-index:
 .. automethod:: Mastodon.status_mute
+   :no-index:
 .. automethod:: Mastodon.status_unmute
+   :no-index:
 .. automethod:: Mastodon.status_bookmark
+   :no-index:
 .. automethod:: Mastodon.status_unbookmark
+   :no-index:
 .. automethod:: Mastodon.status_delete
+   :no-index:
 .. automethod:: Mastodon.status_update
+   :no-index:
+.. automethod:: Mastodon.generate_media_edit_attributes
+   :no-index:
 .. automethod:: Mastodon.scheduled_statuses
+   :no-index:
 .. automethod:: Mastodon.scheduled_status
+   :no-index:
 .. automethod:: Mastodon.scheduled_status_update
+   :no-index:
 .. automethod:: Mastodon.scheduled_status_delete
+   :no-index:
 .. automethod:: Mastodon.media_post
+   :no-index:
 .. automethod:: Mastodon.media_update
+   :no-index:
+.. automethod:: Mastodon.media
+   :no-index:
 .. automethod:: Mastodon.poll
-.. automethod:: Mastodon.poll_voteAccounts, relationships and lists
+   :no-index:
+.. automethod:: Mastodon.poll_vote
+   :no-index:
+.. automethod:: Mastodon.status_translate
+   :no-index:
 .. automethod:: Mastodon.account_verify_credentials
+   :no-index:
 .. automethod:: Mastodon.me
+   :no-index:
 .. automethod:: Mastodon.account
+   :no-index:
 .. automethod:: Mastodon.account_search
+   :no-index:
 .. automethod:: Mastodon.account_lookup
+   :no-index:
 .. automethod:: Mastodon.accounts
+   :no-index:
 .. automethod:: Mastodon.featured_tags
+   :no-index:
 .. automethod:: Mastodon.featured_tag_suggestions
+   :no-index:
 .. automethod:: Mastodon.account_featured_tags
+   :no-index:
 .. automethod:: Mastodon.endorsements
+   :no-index:
 .. automethod:: Mastodon.account_statuses
-.. automethod:: Mastodon.account_following
+   :no-index:
 .. automethod:: Mastodon.account_familiar_followers
+   :no-index:
 .. automethod:: Mastodon.account_lists
+   :no-index:
 .. automethod:: Mastodon.account_update_credentials
+   :no-index:
 .. automethod:: Mastodon.account_pin
+   :no-index:
 .. automethod:: Mastodon.account_unpin
+   :no-index:
 .. automethod:: Mastodon.account_note_set
+   :no-index:
 .. automethod:: Mastodon.featured_tag_create
+   :no-index:
 .. automethod:: Mastodon.featured_tag_delete
+   :no-index:
 .. automethod:: Mastodon.status_pin
+   :no-index:
 .. automethod:: Mastodon.status_unpin
+   :no-index:
+.. automethod:: Mastodon.account_delete_avatar
+   :no-index:
+.. automethod:: Mastodon.account_delete_header
+   :no-index:
 .. automethod:: Mastodon.account_followers
+   :no-index:
+.. automethod:: Mastodon.account_following    
+   :no-index:
 .. automethod:: Mastodon.account_relationships
+   :no-index:
 .. automethod:: Mastodon.follows
+   :no-index:
 .. automethod:: Mastodon.follow_requests
+   :no-index:
 .. automethod:: Mastodon.suggestions
+   :no-index:
 .. automethod:: Mastodon.account_follow
+   :no-index:
 .. automethod:: Mastodon.account_unfollow
+   :no-index:
 .. automethod:: Mastodon.follow_request_authorize
+   :no-index:
 .. automethod:: Mastodon.follow_request_reject
+   :no-index:
 .. automethod:: Mastodon.suggestion_delete
+   :no-index:
 .. automethod:: Mastodon.mutes
+   :no-index:
 .. automethod:: Mastodon.blocks
+   :no-index:
 .. automethod:: Mastodon.domain_blocks
+   :no-index:
 .. automethod:: Mastodon.account_mute
+   :no-index:
 .. automethod:: Mastodon.account_unmute
+   :no-index:
 .. automethod:: Mastodon.account_block
+   :no-index:
 .. automethod:: Mastodon.account_unblock
+   :no-index:
 .. automethod:: Mastodon.account_remove_from_followers
+   :no-index:
 .. automethod:: Mastodon.domain_block
+   :no-index:
 .. automethod:: Mastodon.domain_unblock
+   :no-index:
 .. automethod:: Mastodon.lists
+   :no-index:
 .. automethod:: Mastodon.list
+   :no-index:
 .. automethod:: Mastodon.list_accounts
+   :no-index:
 .. automethod:: Mastodon.list_create
+   :no-index:
 .. automethod:: Mastodon.list_update
+   :no-index:
 .. automethod:: Mastodon.list_delete
+   :no-index:
 .. automethod:: Mastodon.list_accounts_add
+   :no-index:
 .. automethod:: Mastodon.list_accounts_delete
+   :no-index:
+.. automethod:: Mastodon.followed_tags
+   :no-index:
+.. automethod:: Mastodon.tag_follow
+   :no-index:
+.. automethod:: Mastodon.tag_unfollow
+   :no-index:
 .. automethod:: Mastodon.timeline
+   :no-index:
 .. automethod:: Mastodon.timeline_home
+   :no-index:
 .. automethod:: Mastodon.timeline_local
+   :no-index:
 .. automethod:: Mastodon.timeline_public
+   :no-index:
 .. automethod:: Mastodon.timeline_hashtag
+   :no-index:
 .. automethod:: Mastodon.timeline_list
-.. automethod:: Mastodon.conversationsInstance-wide data and search
+   :no-index:
+.. automethod:: Mastodon.conversations
+   :no-index:
 .. automethod:: Mastodon.instance
+   :no-index:
+.. automethod:: Mastodon.instance_v1    
+   :no-index:
+.. automethod:: Mastodon.instance_v2
+   :no-index:
 .. automethod:: Mastodon.instance_activity
+   :no-index:
 .. automethod:: Mastodon.instance_peers
+   :no-index:
 .. automethod:: Mastodon.instance_health
+   :no-index:
 .. automethod:: Mastodon.instance_nodeinfo
+   :no-index:
 .. automethod:: Mastodon.instance_rules
+   :no-index:
+.. automethod:: Mastodon.instance_extended_description
+   :no-index:
 .. automethod:: Mastodon.directory
+   :no-index:
 .. automethod:: Mastodon.custom_emojis
+   :no-index:
 .. automethod:: Mastodon.announcements
+   :no-index:
 .. automethod:: Mastodon.announcement_dismiss
+   :no-index:
 .. automethod:: Mastodon.announcement_reaction_create
+   :no-index:
 .. automethod:: Mastodon.announcement_reaction_delete
+   :no-index:
 .. automethod:: Mastodon.trending_tags
+   :no-index:
 .. automethod:: Mastodon.trending_statuses
+   :no-index:
 .. automethod:: Mastodon.trending_links
+   :no-index:
 .. automethod:: Mastodon.trends
+   :no-index:
 .. automethod:: Mastodon.search
+   :no-index:
 .. automethod:: Mastodon.search_v2
+   :no-index:
+.. automethod:: Mastodon.instance_domain_blocks
+   :no-index:
+.. automethod:: Mastodon.instance_languages
+   :no-index:
+.. automethod:: Mastodon.instance_translation_languages
+   :no-index:
 .. automethod:: Mastodon.notifications
+   :no-index:
+.. automethod:: Mastodon.notifications_unread_count
+   :no-index:
 .. automethod:: Mastodon.notifications_clear
+   :no-index:
 .. automethod:: Mastodon.notifications_dismiss
+   :no-index:
 .. automethod:: Mastodon.conversations_read
-.. automethod:: Mastodon.filters
+   :no-index:
-.. automethod:: Mastodon.filter
+.. automethod:: Mastodon.grouped_notifications
-.. automethod:: Mastodon.filters_apply
+   :no-index:
-.. automethod:: Mastodon.filter_create
+.. automethod:: Mastodon.grouped_notification
-.. automethod:: Mastodon.filter_update
+   :no-index:
-.. automethod:: Mastodon.filter_delete
+.. automethod:: Mastodon.dismiss_grouped_notification
+   :no-index:
+.. automethod:: Mastodon.grouped_notification_accounts
+   :no-index:
+.. automethod:: Mastodon.unread_grouped_notifications_count
+   :no-index:
+.. automethod:: Mastodon.notifications_policy
+   :no-index:
+.. automethod:: Mastodon.update_notifications_policy
+   :no-index:
+.. automethod:: Mastodon.notification_requests
+   :no-index:
+.. automethod:: Mastodon.notification_request
+   :no-index:
+.. automethod:: Mastodon.accept_notification_request
+   :no-index:
+.. automethod:: Mastodon.dismiss_notification_request
+   :no-index:
+.. automethod:: Mastodon.accept_multiple_notification_requests
+   :no-index:
+.. automethod:: Mastodon.dismiss_multiple_notification_requests
+   :no-index:
+.. automethod:: Mastodon.notifications_merged        
+   :no-index:
+.. automethod:: Mastodon.filters_v2
+   :no-index:
+.. automethod:: Mastodon.filter_v2
+   :no-index:
+.. automethod:: Mastodon.create_filter_v2
+   :no-index:
+.. automethod:: Mastodon.update_filter_v2
+   :no-index:
+.. automethod:: Mastodon.delete_filter_v2
+   :no-index:
+.. automethod:: Mastodon.filter_keywords_v2
+   :no-index:
+.. automethod:: Mastodon.add_filter_keyword_v2
+   :no-index:
+.. automethod:: Mastodon.delete_filter_keyword_v2
+   :no-index:
+.. automethod:: Mastodon.filter_statuses_v2
+   :no-index:
+.. automethod:: Mastodon.add_filter_status_v2
+   :no-index:
+.. automethod:: Mastodon.filter_status_v2
+   :no-index:
+.. automethod:: Mastodon.delete_filter_status_v2
+   :no-index:
 .. automethod:: Mastodon.push_subscription
+   :no-index:
 .. automethod:: Mastodon.push_subscription_set
+   :no-index:
 .. automethod:: Mastodon.push_subscription_update
+   :no-index:
 .. automethod:: Mastodon.push_subscription_generate_keys
+   :no-index:
 .. automethod:: Mastodon.push_subscription_decrypt_push
+   :no-index:
+.. automethod:: Mastodon.filters
+   :no-index:
+.. automethod:: Mastodon.filter
+   :no-index:
+.. automethod:: Mastodon.filters_apply
+   :no-index:
+.. automethod:: Mastodon.filter_create
+   :no-index:
+.. automethod:: Mastodon.filter_update
+   :no-index:
+.. automethod:: Mastodon.filter_delete        
+   :no-index:
 .. automethod:: Mastodon.stream_user
+   :no-index:
 .. automethod:: Mastodon.stream_public
+   :no-index:
 .. automethod:: Mastodon.stream_local
+   :no-index:
 .. automethod:: Mastodon.stream_hashtag
+   :no-index:
 .. automethod:: Mastodon.stream_list
+   :no-index:
 .. automethod:: Mastodon.stream_healthy
+   :no-index:
 .. autoclass:: StreamListener
+   :no-index:
 .. automethod:: StreamListener.on_update
+   :no-index:
 .. automethod:: StreamListener.on_notification
+   :no-index:
 .. automethod:: StreamListener.on_delete
+   :no-index:
 .. automethod:: StreamListener.on_conversation
+   :no-index:
 .. automethod:: StreamListener.on_status_update
+   :no-index:
 .. automethod:: StreamListener.on_unknown_event
+   :no-index:
 .. automethod:: StreamListener.on_abort
+   :no-index:
 .. automethod:: StreamListener.handle_heartbeat
-.. autoclass:: CallbackStreamListenerMisc: Markers, reports
+   :no-index:
+.. autoclass:: CallbackStreamListener
+   :no-index:
 .. automethod:: Mastodon.markers_get
+   :no-index:
 .. automethod:: Mastodon.markers_set
+   :no-index:
 .. automethod:: Mastodon.reports
-.. automethod:: Mastodon.reportUtility: Pagination and Blurhash
+   :no-index:
+.. automethod:: Mastodon.report
+   :no-index:
 .. automethod:: Mastodon.fetch_next
+   :no-index:
 .. automethod:: Mastodon.fetch_previous
+   :no-index:
 .. automethod:: Mastodon.fetch_remaining
+   :no-index:
 .. automethod:: Mastodon.decode_blurhash
+   :no-index:
+.. automethod:: Mastodon.clear_caches
+   :no-index:
+.. automethod:: Mastodon.get_approx_server_time
+   :no-index:
 .. automethod:: Mastodon.admin_accounts_v2
+   :no-index:
 .. automethod:: Mastodon.admin_accounts
+   :no-index:
 .. automethod:: Mastodon.admin_accounts_v1
+   :no-index:
 .. automethod:: Mastodon.admin_account
+   :no-index:
 .. automethod:: Mastodon.admin_account_enable
+   :no-index:
 .. automethod:: Mastodon.admin_account_approve
+   :no-index:
 .. automethod:: Mastodon.admin_account_reject
+   :no-index:
 .. automethod:: Mastodon.admin_account_unsilence
+   :no-index:
 .. automethod:: Mastodon.admin_account_unsuspend
+   :no-index:
 .. automethod:: Mastodon.admin_account_moderate
+   :no-index:
 .. automethod:: Mastodon.admin_reports
+   :no-index:
 .. automethod:: Mastodon.admin_report
+   :no-index:
 .. automethod:: Mastodon.admin_report_assign
+   :no-index:
 .. automethod:: Mastodon.admin_report_unassign
+   :no-index:
 .. automethod:: Mastodon.admin_report_reopen
+   :no-index:
 .. automethod:: Mastodon.admin_report_resolve
-.. automethod:: Mastodon.admin_trending_tags
+   :no-index:
-.. automethod:: Mastodon.admin_trending_statuses
-.. automethod:: Mastodon.admin_trending_links
 .. automethod:: Mastodon.admin_domain_blocks
+   :no-index:
 .. automethod:: Mastodon.admin_create_domain_block
+   :no-index:
 .. automethod:: Mastodon.admin_update_domain_block
+   :no-index:
 .. automethod:: Mastodon.admin_delete_domain_block
+   :no-index:
 .. automethod:: Mastodon.admin_measures
+   :no-index:
 .. automethod:: Mastodon.admin_dimensions
+   :no-index:
 .. automethod:: Mastodon.admin_retention
-
+   :no-index:
+.. automethod:: Mastodon.admin_canonical_email_blocks
+   :no-index:
+.. automethod:: Mastodon.admin_canonical_email_block
+   :no-index:
+.. automethod:: Mastodon.admin_test_canonical_email_block
+   :no-index:
+.. automethod:: Mastodon.admin_create_canonical_email_block
+   :no-index:
+.. automethod:: Mastodon.admin_delete_canonical_email_block
+   :no-index:
+.. automethod:: Mastodon.admin_email_domain_blocks
+   :no-index:
+.. automethod:: Mastodon.admin_email_domain_block
+   :no-index:
+.. automethod:: Mastodon.admin_create_email_domain_block
+   :no-index:
+.. automethod:: Mastodon.admin_delete_email_domain_block
+   :no-index:
+.. automethod:: Mastodon.admin_ip_blocks
+   :no-index:
+.. automethod:: Mastodon.admin_ip_block
+   :no-index:
+.. automethod:: Mastodon.admin_create_ip_block
+   :no-index:
+.. automethod:: Mastodon.admin_update_ip_block
+   :no-index:
+.. automethod:: Mastodon.admin_delete_ip_block
+   :no-index:
+.. automethod:: Mastodon.admin_trending_tags
+   :no-index:
+.. automethod:: Mastodon.admin_trending_statuses
+   :no-index:
+.. automethod:: Mastodon.admin_trending_links
+   :no-index:
+.. automethod:: Mastodon.admin_approve_trending_link
+   :no-index:
+.. automethod:: Mastodon.admin_reject_trending_link
+   :no-index:
+.. automethod:: Mastodon.admin_approve_trending_status
+   :no-index:
+.. automethod:: Mastodon.admin_reject_trending_status
+   :no-index:
+.. automethod:: Mastodon.admin_approve_trending_tag
+   :no-index:
+.. automethod:: Mastodon.admin_reject_trending_tag
+   :no-index:
+

docs/index.rst

@@ -1,6 +1,7 @@
 Mastodon.py
 ===========
 .. py:module:: mastodon
+    :no-index:
 .. py:class: Mastodon
 
 Usage

docs/update_everything_page.sh

@@ -2,6 +2,7 @@
 echo "Every function on a huge CTRL-F-able page" > 15_everything.rst
 echo "=========================================" >> 15_everything.rst
 echo ".. py:module:: mastodon" >> 15_everything.rst
+echo "   :no-index:" >> 15_everything.rst
 echo ".. py:class: Mastodon" >> 15_everything.rst
 echo "" >> 15_everything.rst
 cat 01_general.rst 02_return_values.rst 03_errors.rst 04_auth.rst 05_statuses.rst 06_accounts.rst 07_timelines.rst 08_instances.rst 09_notifications.rst 10_streaming.rst 11_misc.rst 12_utilities.rst 13_admin.rst | grep -E "automethod|autoclass" >> 15_everything.rst
@@ -9,5 +10,8 @@ echo "" >> 15_everything.rst
 
 # Now go through 15_everything.rst and add  :no-index: to all the automethods and autoclasses
 # This is because we don't want to index them, as they are already indexed in their own pages
-sed -i 's/automethod::/automethod:: :no-index:/g' 15_everything.rst
+# sed -i 's/automethod::/automethod:: :no-index:/g' 15_everything.rst
-sed -i 's/autoclass::/autoclass:: :no-index:/g' 15_everything.rst
+# sed -i 's/autoclass::/autoclass:: :no-index:/g' 15_everything.rst
+# not quite right - the :no-index: needs to be on the next line, and we need to keep what comes after the :: (the thing to actually be documented), so capture that and put it in the replacement
+sed -i 's/\(automethod::\|autoclass::\) \(.*\)/\1 \2\n   :no-index:/g' 15_everything.rst
+

mastodon/authentication.py

@@ -136,7 +136,7 @@ class Mastodon(Internals):
 
         `lang` can be used to change the locale Mastodon will use to generate responses. Valid parameters are all ISO 639-1 (two letter)
         or for a language that has none, 639-3 (three letter) language codes. This affects some error messages (those related to validation) and 
-        trends. You can change the language using :ref:`set_language()`.
+        trends. You can change the language using set_language().
 
         The version check mode can be set to "none" (now the default behaviour), "changed" or "created". If set to
         "created", Mastodon.py will throw an error if the version of Mastodon it is connected to is too old

mastodon/filters.py

@@ -159,6 +159,7 @@ class Mastodon(Internals):
         `filter_action` gives the policy to be applied when the filter is matched. Valid values are:
             - "warn": The user is warned if the content matches the filter.
             - "hide": The content is completely hidden if it matches the filter.
+
         NB: Even if you specify "hide", the status will still be returned - it will just have the "filtered" attribute set.
         
         pass a number of seconds as `expires_in` to make the filter expire in that many seconds. Use None for no expiration.
@@ -166,6 +167,7 @@ class Mastodon(Internals):
         pass a list of keyword dicts to initially as `keywords_attributes`, each with the following values:
             - "keyword": The term to filter on.
             - "whole_word": Whether word boundaries should be considered.
+            
         """
         params = self.__generate_params(locals(), for_json=True)
         return self.__api_request('POST', '/api/v2/filters', params, use_json=True)

mastodon/notifications.py

@@ -19,18 +19,19 @@ class Mastodon(Internals):
         user. Pass `account_id` to get only notifications originating from the given account.
 
         There are different types of notifications:
-            * `follow` - A user followed the logged in user
+            - `follow` - A user followed the logged in user
-            * `follow_request` - A user has requested to follow the logged in user (for locked accounts)
+            - `follow_request` - A user has requested to follow the logged in user (for locked accounts)
-            * `favourite` - A user favourited a post by the logged in user
+            - `favourite` - A user favourited a post by the logged in user
-            * `reblog` - A user reblogged a post by the logged in user
+            - `reblog` - A user reblogged a post by the logged in user
-            * `mention` - A user mentioned the logged in user
+            - `mention` - A user mentioned the logged in user
-            * `poll` - A poll the logged in user created or voted in has ended
+            - `poll` - A poll the logged in user created or voted in has ended
-            * `update` - A status the logged in user has reblogged (and only those, as of 4.0.0) has been edited
+            - `update` - A status the logged in user has reblogged (and only those, as of 4.0.0) has been edited
-            * `status` - A user that the logged in user has enabned notifications for has enabled `notify` (see :ref:`account_follow() <account_follow()>`)
+            - `status` - A user that the logged in user has enabned notifications for has enabled `notify` (see :ref:`account_follow() <account_follow()>`)
-            * `admin.sign_up` - For accounts with appropriate permissions: A new user has signed up
+            - `admin.sign_up` - For accounts with appropriate permissions: A new user has signed up
-            * `admin.report` - For accounts with appropriate permissions: A new report has been received
+            - `admin.report` - For accounts with appropriate permissions: A new report has been received
-            * `severed_relationships` - Some of the logged in users relationships have been severed due to a moderation action on this server
+            - `severed_relationships` - Some of the logged in users relationships have been severed due to a moderation action on this server
-            * `moderation_warning` - The logged in user has been warned by a moderator
+            - `moderation_warning` - The logged in user has been warned by a moderator
+            
         Parameters `exclude_types` and `types` are array of these types, specifying them will in- or exclude the
         types of notifications given. It is legal to give both parameters at the same tine, the result will then
         be the intersection of the results of both filters. Specifying `mentions_only` is a deprecated way to set

mastodon/push.py

@@ -122,7 +122,7 @@ class Mastodon(Internals):
         """
         Modifies what kind of events the app wishes to subscribe to.
 
-        Parameters are as in :ref:`push_subscription_create() <push_subscription_create()>`.
+        Parameters are as in push_subscription_set().
 
         Returned object reflects the updated push subscription.
         """

mastodon/streaming_endpoints.py

@@ -41,7 +41,7 @@ class Mastodon(Internals):
         """
         Streams local public events.
 
-        This function is deprecated. Please use :ref:`stream_public() <stream_public()>` with parameter `local` set to True instead.
+        This function is deprecated. Please use stream_public() with parameter `local` set to True instead.
         """
         #return self.__stream('/api/v1/streaming/public/local', listener, run_async=run_async, timeout=timeout, reconnect_async=reconnect_async, reconnect_async_wait_sec=reconnect_async_wait_sec)
         return self.stream_public(listener, run_async=run_async, timeout=timeout, reconnect_async=reconnect_async, reconnect_async_wait_sec=reconnect_async_wait_sec, local=True)