Completely overhaul the documentation

readthedocs/modules/client.rst

@@ -0,0 +1,102 @@
+.. _telethon-client:
+
+==============
+TelegramClient
+==============
+
+.. currentmodule:: telethon.client
+
+The `TelegramClient <telegramclient.TelegramClient>` aggregates several mixin
+classes to provide all the common functionality in a nice, Pythonic interface.
+Each mixin has its own methods, which you all can use.
+
+**In short, to create a client you must run:**
+
+.. code-block:: python
+
+    import asyncio
+    from telethon import TelegramClient
+
+    async def main():
+        client = await TelegramClient(name, api_id, api_hash).start()
+        # Now you can use all client methods listed below, like for example...
+        await client.send_message('me', 'Hello to myself!')
+
+    asyncio.get_event_loop().run_until_complete(main())
+
+
+You **don't** need to import these `AuthMethods`, `MessageMethods`, etc.
+Together they are the `TelegramClient <telegramclient.TelegramClient>` and
+you can access all of their methods.
+
+See :ref:`client-ref` for a short summary.
+
+.. automodule:: telethon.client.telegramclient
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.client.telegrambaseclient
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.client.account
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.client.auth
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.client.bots
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.client.buttons
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.client.chats
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.client.dialogs
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.client.downloads
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.client.messageparse
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.client.messages
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.client.updates
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.client.uploads
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.client.users
+    :members:
+    :undoc-members:
+    :show-inheritance:

readthedocs/modules/custom.rst

@@ -0,0 +1,145 @@
+==============
+Custom package
+==============
+
+The `telethon.tl.custom` package contains custom classes that the library
+uses in order to make working with Telegram easier. Only those that you
+are supposed to use will be documented here. You can use undocumented ones
+at your own risk.
+
+More often than not, you don't need to import these (unless you want
+type hinting), nor do you need to manually create instances of these
+classes. They are returned by client methods.
+
+.. contents::
+
+.. automodule:: telethon.tl.custom
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+AdminLogEvent
+=============
+
+.. automodule:: telethon.tl.custom.adminlogevent
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Button
+======
+
+.. automodule:: telethon.tl.custom.button
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+ChatGetter
+==========
+
+.. automodule:: telethon.tl.custom.chatgetter
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Conversation
+============
+
+.. automodule:: telethon.tl.custom.conversation
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Dialog
+======
+
+.. automodule:: telethon.tl.custom.dialog
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Draft
+=====
+
+.. automodule:: telethon.tl.custom.draft
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+File
+====
+
+.. automodule:: telethon.tl.custom.file
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Forward
+=======
+
+.. automodule:: telethon.tl.custom.forward
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+InlineBuilder
+=============
+
+.. automodule:: telethon.tl.custom.inlinebuilder
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+InlineResult
+============
+
+.. automodule:: telethon.tl.custom.inlineresult
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+InlineResults
+=============
+
+.. automodule:: telethon.tl.custom.inlineresults
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Message
+=======
+
+.. automodule:: telethon.tl.custom.message
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+MessageButton
+=============
+
+.. automodule:: telethon.tl.custom.messagebutton
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+SenderGetter
+============
+
+.. automodule:: telethon.tl.custom.sendergetter
+    :members:
+    :undoc-members:
+    :show-inheritance:

readthedocs/modules/errors.rst

@@ -0,0 +1,19 @@
+.. _telethon-errors:
+
+==========
+API Errors
+==========
+
+These are the base errors that Telegram's API may raise.
+
+See :ref:`rpc-errors` for a more friendly explanation.
+
+.. automodule:: telethon.errors.common
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.errors.rpcbaseerrors
+    :members:
+    :undoc-members:
+    :show-inheritance:

readthedocs/modules/events.rst

@@ -0,0 +1,65 @@
+.. _telethon-events:
+
+=============
+Update Events
+=============
+
+.. currentmodule:: telethon.events
+
+Every event (builder) subclasses `common.EventBuilder`,
+so all the methods in it can be used from any event builder/event instance.
+
+.. automodule:: telethon.events.common
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.events.newmessage
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.events.chataction
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.events.userupdate
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.events.messageedited
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.events.messagedeleted
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.events.messageread
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.events.callbackquery
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.events.inlinequery
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.events.raw
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.events
+    :members:
+    :undoc-members:
+    :show-inheritance:

readthedocs/modules/helpers.rst

@@ -0,0 +1,8 @@
+=======
+Helpers
+=======
+
+.. automodule:: telethon.helpers
+    :members:
+    :undoc-members:
+    :show-inheritance:

readthedocs/modules/network.rst

@@ -0,0 +1,33 @@
+.. _telethon-network:
+
+================
+Connection Modes
+================
+
+The only part about network that you should worry about are
+the different connection modes, which are the following:
+
+.. automodule:: telethon.network.connection.tcpfull
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.network.connection.tcpabridged
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.network.connection.tcpintermediate
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.network.connection.tcpobfuscated
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.network.connection.http
+    :members:
+    :undoc-members:
+    :show-inheritance:

readthedocs/modules/sessions.rst

@@ -0,0 +1,27 @@
+.. _telethon-sessions:
+
+========
+Sessions
+========
+
+These are the different built-in session storage that you may subclass.
+
+.. automodule:: telethon.sessions.abstract
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.sessions.memory
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.sessions.sqlite
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: telethon.sessions.string
+    :members:
+    :undoc-members:
+    :show-inheritance:

readthedocs/modules/utils.rst

@@ -0,0 +1,12 @@
+.. _telethon-utils:
+
+=========
+Utilities
+=========
+
+These are the utilities that the library has to offer.
+
+.. automodule:: telethon.utils
+    :members:
+    :undoc-members:
+    :show-inheritance: