python-telegram-bot/docs/source/index.rst

.. 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.

.. raw:: html

    <div style="display: none">

Hidden Headline
===============
This is just here to get furo to display the right sidebar.

.. raw:: html

    </div>

.. include:: ../../README.rst

.. The toctrees are hidden such that they don't render on the start page but still include the contents into the documentation.

.. toctree::
   :hidden:
   :caption: Reference

   telegram
   telegram.ext
   telegram_auxil
   Telegrams Bot API Docs <https://core.telegram.org/bots/api>

.. toctree::
   :hidden:
   :caption: Resources

   examples
   Wiki <https://github.com/python-telegram-bot/python-telegram-bot/wiki>

.. toctree::
   :hidden:
   :caption: Project

   stability_policy
   changelog
   coc
   contributing
   testing
   Website <https://python-telegram-bot.org>
   GitHub Repository <https://github.com/python-telegram-bot/python-telegram-bot/>
   Telegram Channel <https://t.me/pythontelegrambotchannel/>
   Telegram User Group <https://t.me/pythontelegrambotgroup/>
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.

Restructure Readme (#4362) 2024-07-10 20:36:47 +02:00			`.. raw:: html`

			`<div style="display: none">`

			`Hidden Headline`
			`===============`
			`This is just here to get furo to display the right sidebar.`

			`.. raw:: html`

			`</div>`

Documentation Fixes & Improvements (#2969) Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> 2022-05-06 17:15:23 +02:00			`.. include:: ../../README.rst`
Adding docs 2015-08-11 21:17:38 +02:00
Move Examples To Documentation (#3089) 2022-06-09 17:22:32 +02:00			`.. The toctrees are hidden such that they don't render on the start page but still include the contents into the documentation.`
Doc Fixes (#2437) Co-authored-by: poolitzer <25934244+Poolitzer@users.noreply.github.com> Co-authored-by: Harshil <ilovebhagwan@gmail.com> Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> 2021-04-30 10:47:41 +02:00
			`.. toctree::`
Documentation Fixes & Improvements (#2969) Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> 2022-05-06 17:15:23 +02:00			`:hidden:`
			`:caption: Reference`
Docs update (#728) Amazing new documentation. 2017-07-23 22:33:08 +02:00
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`
Documentation Fixes & Improvements (#2969) Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> 2022-05-06 17:15:23 +02:00			`telegram.ext`
			`telegram_auxil`
			`Telegrams Bot API Docs <https://core.telegram.org/bots/api>`
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
Move Examples To Documentation (#3089) 2022-06-09 17:22:32 +02:00			`.. toctree::`
			`:hidden:`
			`:caption: Resources`

			`examples`
			`Wiki <https://github.com/python-telegram-bot/python-telegram-bot/wiki>`

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::`
Documentation Fixes & Improvements (#2969) Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> 2022-05-06 17:15:23 +02:00			`:hidden:`
			`:caption: Project`
Adding docs 2015-08-11 21:17:38 +02:00
Add a Stability Policy (#3622) Co-authored-by: poolitzer <github@poolitzer.eu> Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> Co-authored-by: Dmitry Kolomatskiy <58207913+lemontree210@users.noreply.github.com> 2023-05-07 14:50:41 +02:00			`stability_policy`
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`
Add a Stability Policy (#3622) Co-authored-by: poolitzer <github@poolitzer.eu> Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> Co-authored-by: Dmitry Kolomatskiy <58207913+lemontree210@users.noreply.github.com> 2023-05-07 14:50:41 +02:00			`coc`
			`contributing`
			`testing`
Documentation Fixes & Improvements (#2969) Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> 2022-05-06 17:15:23 +02:00			`Website <https://python-telegram-bot.org>`
			`GitHub Repository <https://github.com/python-telegram-bot/python-telegram-bot/>`
			`Telegram Channel <https://t.me/pythontelegrambotchannel/>`
			`Telegram User Group <https://t.me/pythontelegrambotgroup/>`