python/aiogram
1
0
Fork 0
mirror of https://github.com/aiogram/aiogram.git synced 2025-12-15 03:08:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
aiogram/docs/index.rst

30 lines
431 B
ReStructuredText
Raw Normal View History

Update README and docs main page
2021-10-11 01:29:06 +03:00
.. include:: ../README.rst
Upgrade architecture + 5.0 Bot API (#469) Upgrade architecture + 5.0 Bot API (#469) * Moved `methods`, `types` and `client` to root package * Removed update handler from routers to dispatcher * Reworked events propagation mechanism to handlers * Reworked inner middlewares logic (very small change) * Updated to Bot API 5.0 * Initial migration from MkDocs to Sphinx + config for readthedocs
2021-01-26 21:20:52 +02:00
Simple usage
------------
.. literalinclude:: ../examples/echo_bot.py
Add context manager support for bot client (#1468) * Add context manager support for bot client The bot client now supports the context manager protocol, providing automatic resource management. This enhancement helps to automatically close the session when leaving the context, which cleans up resources better. The documentation and tests have been updated accordingly to illustrate this new feature. Moreover, an example of usage without a dispatcher has been provided to clarify its use in simple cases. * Added changelog
2024-04-22 23:42:47 +03:00
Usage without dispatcher
------------------------
Just only interact with Bot API, without handling events
.. literalinclude:: ../examples/without_dispatcher.py
Upgrade architecture + 5.0 Bot API (#469) Upgrade architecture + 5.0 Bot API (#469) * Moved `methods`, `types` and `client` to root package * Removed update handler from routers to dispatcher * Reworked events propagation mechanism to handlers * Reworked inner middlewares logic (very small change) * Updated to Bot API 5.0 * Initial migration from MkDocs to Sphinx + config for readthedocs
2021-01-26 21:20:52 +02:00
Contents
========
.. toctree::
:maxdepth: 3
install
Migration guide 2.x -> 3.0 (#1143) * Initial commit for docs cleanup * Update migration guide * More docs * Added changes description * Small fixes
2023-07-29 22:36:12 +03:00
migration_2_to_3
Upgrade architecture + 5.0 Bot API (#469) Upgrade architecture + 5.0 Bot API (#469) * Moved `methods`, `types` and `client` to root package * Removed update handler from routers to dispatcher * Reworked events propagation mechanism to handlers * Reworked inner middlewares logic (very small change) * Updated to Bot API 5.0 * Initial migration from MkDocs to Sphinx + config for readthedocs
2021-01-26 21:20:52 +02:00
api/index
dispatcher/index
Dev 3.x i18n & improvements (#696) * Added base code and make code improvements * Auto-exclude coverage for `if TYPE_CHECKING:` * Fixed current coverage * Cover I18n module * Update pipeline * Fixed annotations * Added docs * Move exceptions * Added tests for KeyboardBuilder and initial docs * Remove help generator (removed from sources tree, requires rewrite) * Added patch-notes #698, #699, #700, #701, #702, #703
2021-09-22 00:52:38 +03:00
utils/index
`towncrier` integration (#647) * Added towncrier and clone changelog from GitHub Releases page * Added record to changelog * Extended makefile * Fix typo * Changed ref in changelog * Auto-confirm towncrier question on build Co-authored-by: evgfilim1 <evgfilim1@yandex.ru>
2021-08-01 19:08:03 +03:00
changelog
Migrate to hatchling (#1095) * Migrate to hatchling instead of poetry, ruff instead of flake8 * Migrate to hatchling instead of poetry, ruff instead of flake8 * Update tests suite * venv? * -m venv? * Change dependencies * Remove venv * Change mypy config * Added changelog * Mark uvloop incompatible with pypy * Update release script * Use internal caching for dependencies * Re-disable cov branches * Added contributing guide
2023-01-12 02:49:58 +02:00
contributing
Reference in a new issue Copy permalink