Skip to content

Commit

Permalink
Странности с сборкой доки
Browse files Browse the repository at this point in the history
  • Loading branch information
K1rL3s committed Feb 1, 2024
1 parent cf4e8c8 commit c9b6eb0
Show file tree
Hide file tree
Showing 13 changed files with 16 additions and 33 deletions.
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ version: 2
build:
os: ubuntu-22.04
tools:
python: "3.12"
python: "3.8"

mkdocs:
configuration: mkdocs.yml
Expand Down
2 changes: 1 addition & 1 deletion aliceio/dispatcher/event/bases.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
MiddlewareEventType = TypeVar("MiddlewareEventType", bound=AliceObject)
NextMiddlewareType = Callable[[MiddlewareEventType, Dict[str, Any]], Awaitable[Any]]
MiddlewareType = Union[
BaseMiddleware,
BaseMiddleware[Any],
Callable[
[NextMiddlewareType[MiddlewareEventType], MiddlewareEventType, Dict[str, Any]],
Awaitable[Any],
Expand Down
7 changes: 1 addition & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,7 @@

Добро пожаловать в документацию AliceIO!

Начинающим рекомендуется ознакомиться с [туториалом](tutorial/start.md) и [FAQ](tutorial/faq.md), а после них с технической документацией:

* [Клиент](https://ya.ru)
* [Хендлинг](https://ya.ru)
* [Tools](https://ya.ru)
* [Установка](install.md)
Начинающим рекомендуется ознакомиться с [туториалом](tutorial/start.md) и [FAQ](tutorial/faq.md)


> Проект написан с использованием исходного кода [aiogram](https://github.com/aiogram/aiogram/), [vkbottle](https://github.com/vkbottle/vkbottle/) и [aioalice](https://github.com/mahenzon/aioalice)
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/code-separation.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,5 +114,5 @@ if __name__ == "__main__":

## Примеры

* [multi_file_skill](https://ya.ru)
* [multi_file_skill](https://github.com/K1rL3s/aliceio/tree/master/examples/multi_file_skill)
* [vkbottle](https://vkbottle.readthedocs.io/ru/latest/tutorial/code-separation/)
2 changes: 1 addition & 1 deletion docs/tutorial/dependency-injection.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,5 +94,5 @@ async def start_handler(message: Message, real_text: str) -> str:

## Примеры

* [context_addition.py](https://ya.ru)
* [context_addition.py](https://github.com/K1rL3s/aliceio/blob/master/examples/context_addition.py)
* [aiogram](https://docs.aiogram.dev/en/dev-3.x/dispatcher/dependency_injection.html)
2 changes: 1 addition & 1 deletion docs/tutorial/error-handling.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,4 @@ async def error_handler(event: ErrorEvent):

## Примеры

* [error_handling.py](https://ya.ru)
* [error_handling.py](https://github.com/K1rL3s/aliceio/blob/master/examples/error_handling.py)
6 changes: 3 additions & 3 deletions docs/tutorial/filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
* Синхронными функциями (`#!python def my_filter(*args, **kwargs): pass`)
* Анонимными функциями (`#!python lambda event: True`)
* Любым awaitable объектом
* Подклассом [`aliceio.filters.base.Filter`](https://ya.ru)
* Экземпляром [`Магического фильтра`](https://ya.ru)
* Подклассом [`aliceio.filters.base.Filter`](../aliceio/filters/base.md)
* Экземпляром [`Магического фильтра`](../aliceio/filters/magic-filter.md)

И они должны возвращать `bool` или `dict`.
Если возвращается словарь, полученные данные будут переданы следующим фильтрам и обработчику в качестве ключевых аргументов.
Expand Down Expand Up @@ -135,6 +135,6 @@ async def any_message_handler(message: ...) -> Response:

## Примеры

* [filters.py](https://ya.ru)
* [filters.py](https://github.com/K1rL3s/aliceio/blob/master/examples/filters.py)
* [aiogram](https://docs.aiogram.dev/en/dev-3.x/dispatcher/filters/index.html)
* [aiogram-magic](https://docs.aiogram.dev/en/dev-3.x/dispatcher/filters/magic_filters.html)
2 changes: 1 addition & 1 deletion docs/tutorial/finite-state-machine.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,5 +140,5 @@ async def cancel_handler(message: Message, state: FSMContext) -> Response:

## Примеры

* [finite_state_machine.py](https://ya.ru)
* [finite_state_machine.py](https://github.com/K1rL3s/aliceio/blob/master/examples/finite_state_machine.py)
* [aiogram](https://docs.aiogram.dev/en/dev-3.x/dispatcher/finite_state_machine/index.html)
4 changes: 2 additions & 2 deletions docs/tutorial/first-skill.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,8 @@ if __name__ == "__main__":

# Примеры

* [echo_bot.py](https://ya.ru)
* [echo_bot_ssl.py](https://ya.ru)
* [echo_bot.py](https://github.com/K1rL3s/aliceio/blob/master/examples/echo_bot.py)
* [echo_bot_ssl.py](https://github.com/K1rL3s/aliceio/blob/master/examples/echo_bot_ssl.py)

Полный код из этой главы:

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,4 +76,4 @@

# Примеры

* [methods.py](https://ya.ru)
* [methods.py](https://github.com/K1rL3s/aliceio/blob/master/examples/methods.py)
2 changes: 1 addition & 1 deletion docs/tutorial/middlewares.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,5 +94,5 @@ async def check_authorization(

# Примеры

* [middlewares.py](https://ya.ru)
* [middlewares.py](https://github.com/K1rL3s/aliceio/blob/master/examples/middlewares.py)
* [aiogram](https://docs.aiogram.dev/en/dev-3.x/dispatcher/middlewares.html)
2 changes: 1 addition & 1 deletion docs/tutorial/special-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ dispatcher.shutdown.register(on_shutdown)

## Примеры

* [on_dispatcher_event.py](https://ya.ru)
* [on_dispatcher_event.py](https://github.com/K1rL3s/aliceio/blob/master/examples/on_dispatcher_event.py)
14 changes: 1 addition & 13 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ keywords = [
]
classifiers = [
"License :: OSI Approved :: MIT License",
"Development Status :: 1 - Planning",
"Development Status :: 4 - Beta",
"Environment :: Console",
"Framework :: AsyncIO",
"Typing :: Typed",
Expand Down Expand Up @@ -54,9 +54,6 @@ redis = [
proxy = [
"aiohttp-socks~=0.8.3",
]
i18n = [
"Babel~=2.13.0",
]
test = [
"pytest~=7.4.2",
"pytest-html~=4.0.2",
Expand Down Expand Up @@ -95,8 +92,6 @@ features = [
"fast",
"redis",
"proxy",
"i18n",
"cli",
]
post-install-commands = [
"pre-commit install",
Expand All @@ -114,9 +109,7 @@ features = [
"fast",
"redis",
"proxy",
"i18n",
"docs",
"cli",
]

[tool.hatch.envs.dev]
Expand All @@ -126,19 +119,15 @@ features = [
"fast",
"redis",
"proxy",
"i18n",
"test",
"cli",
]

[tool.hatch.envs.test]
features = [
"fast",
"redis",
"proxy",
"i18n",
"test",
"cli",
]

[tool.hatch.envs.test.scripts]
Expand Down Expand Up @@ -241,7 +230,6 @@ module = [
"async_lru",
"uvloop",
"redis.*",
"babel.*",
]
ignore_missing_imports = true
disallow_untyped_defs = true
Expand Down

0 comments on commit c9b6eb0

Please sign in to comment.