Telethon/readthedocs/index.rst

124 lines
2.9 KiB
ReStructuredText
Raw Normal View History

2017-11-19 19:56:05 +03:00
.. Telethon documentation master file, created by
sphinx-quickstart on Fri Nov 17 15:36:11 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
====================================
2017-11-19 19:56:05 +03:00
Welcome to Telethon's documentation!
====================================
Pure Python 3 Telegram client library.
Official Site `here <https://lonamiwebs.github.io/Telethon>`_.
Please follow the links on the index below to navigate from here,
or use the menu on the left. Remember to read the :ref:`changelog`
when you upgrade!
.. important::
2017-11-19 19:56:05 +03:00
2018-10-06 21:20:11 +03:00
* Are you new here? Jump straight into :ref:`getting-started`!
* Looking for available friendly methods? See :ref:`telethon-client`.
* Used Telethon before v1.0? See :ref:`compatibility-and-convenience`.
* Need the full API reference? https://lonamiwebs.github.io/Telethon/.
2018-01-09 20:04:51 +03:00
What is this?
*************
Telegram is a popular messaging application. This library is meant
to make it easy for you to write Python programs that can interact
with Telegram. Think of it as a wrapper that has already done the
heavy job for you, so you can focus on developing an application.
2017-11-20 07:12:31 +03:00
.. _installation-and-usage:
2017-11-19 19:56:05 +03:00
.. toctree::
2017-11-20 07:12:31 +03:00
:maxdepth: 2
:caption: Installation and Simple Usage
extra/basic/getting-started
extra/basic/installation
extra/basic/creating-a-client
extra/basic/telegram-client
extra/basic/entities
2017-11-20 07:12:31 +03:00
extra/basic/working-with-updates
2018-10-06 21:20:11 +03:00
extra/basic/compatibility-and-convenience
2017-11-20 07:12:31 +03:00
2017-11-19 19:56:05 +03:00
2017-11-20 07:12:31 +03:00
.. _Advanced-usage:
2017-11-19 19:56:05 +03:00
.. toctree::
2017-11-20 07:12:31 +03:00
:maxdepth: 2
:caption: Advanced Usage
2017-11-19 19:56:05 +03:00
extra/advanced-usage/accessing-the-full-api
extra/advanced-usage/sessions
extra/advanced-usage/update-modes
extra/advanced-usage/mastering-telethon
2018-10-06 21:20:11 +03:00
extra/advanced-usage/mastering-asyncio
.. _Examples:
.. toctree::
:maxdepth: 2
:caption: Examples
extra/examples/telegram-client
extra/examples/working-with-messages
extra/examples/chats-and-channels
extra/examples/users
extra/examples/projects-using-telethon
2017-11-20 07:12:31 +03:00
.. _Troubleshooting:
2017-11-19 19:56:05 +03:00
.. toctree::
2017-11-20 07:12:31 +03:00
:maxdepth: 2
:caption: Troubleshooting
extra/troubleshooting/enable-logging
extra/troubleshooting/deleted-limited-or-deactivated-accounts
extra/troubleshooting/rpc-errors
.. _Developing:
.. toctree::
:maxdepth: 2
:caption: Developing
extra/developing/philosophy.rst
extra/developing/api-status.rst
extra/developing/test-servers.rst
extra/developing/project-structure.rst
extra/developing/coding-style.rst
extra/developing/understanding-the-type-language.rst
extra/developing/tips-for-porting-the-project.rst
extra/developing/telegram-api-in-other-languages.rst
.. _More:
.. toctree::
:maxdepth: 2
:caption: More
extra/changelog
extra/wall-of-shame.rst
2017-11-20 07:12:31 +03:00
.. toctree::
:caption: Telethon modules
modules
2017-11-19 19:56:05 +03:00
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`