OpenSource/python-telegram-bot
OpenSource/python-telegram-bot
1
0
Fork 0
mirror of https://github.com/python-telegram-bot/python-telegram-bot.git synced 2024-12-02 21:16:58 +01:00
Code Issues Projects Releases Packages Wiki Activity
python-telegram-bot/docs/source/index.rst

39 lines
1.3 KiB
ReStructuredText
Raw Normal View History

Adding docs
2015-08-11 21:17:38 +02:00
.. Python Telegram Bot documentation master file, created by
sphinx-quickstart on Mon Aug 10 22:25:07 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Python Telegram Bot's documentation!
===============================================
Documentation fixes (#1348) * Clarify InlineKeyboardButton callback-data docstring Fixes #1267 * Improve documentation slightly - Prettier changelog - Link to examples on frontpage - Link to wiki on frontpage - Put telegram.ext in own sidebar thingy * Improve ext.Filters documentation Superseeds #1089 - Remove `:obj:Filter` as it's pretty obvious that it's a filter since it's in this module. It also made the html output about 1/3 times longer to scroll through. - Add an __all__ to reorder so Filter is at the top instead of BaseFilter - Add a proper docstring for document that documents the attributes (this is the #1089 part) - Also fix a couple of grammar errors. * Fix indentation in telegram.rst * Add `git describe --long --tags` to the `python -m telegram` output * Use admonition for examples to make them *pop* better * Remove automodule telegram Sphinx was whining a lot and it doesn't actually seem to be needed in any way? * Fix Filters.document docstring per CR Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Fix spelling error in docs index Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Setting needs_sphinx to 1.7.9 so we don't have more issues with incongruent versions * Fixed last warnings * Make pre-commit happy
2019-02-18 20:04:52 +01:00
Guides and tutorials
====================
If you're just starting out with the library, we recommend following our `"Your first Bot" <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Extensions-%E2%80%93-Your-first-Bot>`_ tutorial that you can find on our `wiki <https://github.com/python-telegram-bot/python-telegram-bot/wiki>`_.
On our wiki you will also find guides like how to use handlers, webhooks, emoji, proxies and much more.
Examples
========
A great way to learn is by looking at examples. Ours can be found at our `github in the examples folder <https://github.com/python-telegram-bot/python-telegram-bot/tree/master/examples>`_.
Reference
=========
Below you can find a reference of all the classes and methods in python-telegram-bot.
Apart from the telegram.ext package the objects should reflect the types defined in the `official telegram bot api documentation <https://core.telegram.org/bots/api>`_
Docs update (#728) Amazing new documentation.
2017-07-23 22:33:08 +02:00
Adding docs
2015-08-11 21:17:38 +02:00
.. toctree::
Sphinx restructuring: Now builds PDF and better HTML docs (#449) * update sphinx source files to properly build latexpdf and improve html build * fix docstrings and sphinx sources to get rid of warnings * add telegram.contrib.rst
2016-11-01 06:53:51 +01:00
telegram
Adding docs
2015-08-11 21:17:38 +02:00
Drop 3.3 from support (#930) * Remove 3.3 from testsuite and setup.py * add changelog to the docs [CI skip]
2017-12-08 22:38:23 +01:00
Changelog
---------
Documentation fixes (#1348) * Clarify InlineKeyboardButton callback-data docstring Fixes #1267 * Improve documentation slightly - Prettier changelog - Link to examples on frontpage - Link to wiki on frontpage - Put telegram.ext in own sidebar thingy * Improve ext.Filters documentation Superseeds #1089 - Remove `:obj:Filter` as it's pretty obvious that it's a filter since it's in this module. It also made the html output about 1/3 times longer to scroll through. - Add an __all__ to reorder so Filter is at the top instead of BaseFilter - Add a proper docstring for document that documents the attributes (this is the #1089 part) - Also fix a couple of grammar errors. * Fix indentation in telegram.rst * Add `git describe --long --tags` to the `python -m telegram` output * Use admonition for examples to make them *pop* better * Remove automodule telegram Sphinx was whining a lot and it doesn't actually seem to be needed in any way? * Fix Filters.document docstring per CR Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Fix spelling error in docs index Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Setting needs_sphinx to 1.7.9 so we don't have more issues with incongruent versions * Fixed last warnings * Make pre-commit happy
2019-02-18 20:04:52 +01:00
.. toctree::
:maxdepth: 2
Adding docs
2015-08-11 21:17:38 +02:00
Documentation fixes (#1348) * Clarify InlineKeyboardButton callback-data docstring Fixes #1267 * Improve documentation slightly - Prettier changelog - Link to examples on frontpage - Link to wiki on frontpage - Put telegram.ext in own sidebar thingy * Improve ext.Filters documentation Superseeds #1089 - Remove `:obj:Filter` as it's pretty obvious that it's a filter since it's in this module. It also made the html output about 1/3 times longer to scroll through. - Add an __all__ to reorder so Filter is at the top instead of BaseFilter - Add a proper docstring for document that documents the attributes (this is the #1089 part) - Also fix a couple of grammar errors. * Fix indentation in telegram.rst * Add `git describe --long --tags` to the `python -m telegram` output * Use admonition for examples to make them *pop* better * Remove automodule telegram Sphinx was whining a lot and it doesn't actually seem to be needed in any way? * Fix Filters.document docstring per CR Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Fix spelling error in docs index Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Setting needs_sphinx to 1.7.9 so we don't have more issues with incongruent versions * Fixed last warnings * Make pre-commit happy
2019-02-18 20:04:52 +01:00
changelog
Adding docs
2015-08-11 21:17:38 +02:00
Reference in a new issue Copy permalink