aliceio

1
site_name: AliceIO Docs
2
site_author: AliceIO
3
site_description: Awesome Alice framework
4
site_url: https://aliceio.rtfd.io/ru/latest/
5
repo_name: aliceio
6
repo_url: https://github.com/K1rL3s/aliceio
7
edit_uri: edit/master/docs/
8
copyright: <a href="https://github.com/K1rL3s/aliceio/tree/master/LICENSE" target="_blank" rel="noopener">Лицензия</a>
9

10
extra:
11
  generator: false
12
  disqus: ""
13
  social:
14
    - icon: fontawesome/brands/telegram
15
      link: https://t.me/aliceio_chat
16
      name: Наш ТГ чат
17

18
nav:
19
  - Документация:
20
      - index.md
21
      - Установка: install.md
22
      - API Алисы:
23
          - Навык: aliceio/client/skill.md
24
          - Enums: aliceio/enums/all-enums.md
25
          - Методы:
26
              - Base: aliceio/methods/base.md
27
              - Статус: aliceio/methods/status.md
28
              - Изображения:
29
                  - Загрузить: aliceio/methods/images/upload-image.md
30
                  - Получить: aliceio/methods/images/get-images.md
31
                  - Удалить: aliceio/methods/images/delete-image.md
32
              - Звуки:
33
                  - Загрузить: aliceio/methods/sounds/upload-sound.md
34
                  - Получить: aliceio/methods/sounds/get-sounds.md
35
                  - Удалить: aliceio/methods/sounds/delete-sound.md
36
          - Типы:
37
              - AliceEvent: aliceio/types/alice-event.md
38
              - AliceRequest: aliceio/types/alice-request.md
39
              - AliceResponse: aliceio/types/alice-response.md
40
              - AnalyticEvent: aliceio/types/analytic-event.md
41
              - Analytics: aliceio/types/analytics.md
42
              - ApiState: aliceio/types/api-state.md
43
              - Application: aliceio/types/application.md
44
              - AudioPlayer: aliceio/types/audio-player.md
45
              - AudioPlayerDirective: aliceio/types/audio-player-directive.md
46
              - AudioPlayerError: aliceio/types/audio-player-error.md
47
              - AudioPlayerItem: aliceio/types/audio-player-item.md
48
              - Base: aliceio/types/base.md
49
              - BigImage: aliceio/types/big-image.md
50
              - ButtonPressed: aliceio/types/button-pressed.md
51
              - Card: aliceio/types/card.md
52
              - CardFooter: aliceio/types/card-footer.md
53
              - CardHeader: aliceio/types/card-header.md
54
              - Datetime: aliceio/types/datetime.md
55
              - Directives: aliceio/types/directives.md
56
              - Entity: aliceio/types/entity.md
57
              - ErrorEvent: aliceio/types/error-event.md
58
              - ErrorResult: aliceio/types/error-result.md
59
              - FIOEntity: aliceio/types/fio-entity.md
60
              - GEOEntity: aliceio/types/geo-entity.md
61
              - ImageGallery: aliceio/types/image-gallery.md
62
              - ImageGalleryItem: aliceio/types/image-gallery-item.md
63
              - InputFile: aliceio/types/input-file.md
64
              - Interface: aliceio/types/interfaces.md
65
              - ItemImage: aliceio/types/item-image.md
66
              - ItemsList: aliceio/types/items-list.md
67
              - Markup: aliceio/types/markup.md
68
              - MediaButton: aliceio/types/media-button.md
69
              - Message: aliceio/types/message.md
70
              - Meta: aliceio/types/meta.md
71
              - MetaData: aliceio/types/metadata.md
72
              - NLU: aliceio/types/nlu.md
73
              - NLUEntity: aliceio/types/nlu-entity.md
74
              - NumberEntity: aliceio/types/number-entity.md
75
              - Payload: aliceio/types/payload.md
76
              - Purchase: aliceio/types/purchase.md
77
              - Quota: aliceio/types/quota.md
78
              - Response: aliceio/types/response.md
79
              - Result: aliceio/types/result.md
80
              - Session: aliceio/types/session.md
81
              - ShowItemMeta: aliceio/types/show-item-meta.md
82
              - ShowPull: aliceio/types/show-pull.md
83
              - SpaceStatus: aliceio/types/space-status.md
84
              - Stream: aliceio/types/stream.md
85
              - TextButton: aliceio/types/text-button.md
86
              - TimeoutEvent: aliceio/types/timeout-event.md
87
              - TokensEntity: aliceio/types/tokens-entity.md
88
              - Update: aliceio/types/update.md
89
              - UploadedImage: aliceio/types/uploaded-image.md
90
              - UploadedSound: aliceio/types/uploaded-sound.md
91
              - URL: aliceio/types/url.md
92
              - User: aliceio/types/user.md
93
          - Клиент:
94
              - Сервер Алисы: aliceio/client/alice.md
95
              - ContextController: aliceio/client/context-controller.md
96
              - Сессия:
97
                  - Base: aliceio/client/session/base.md
98
                  - Aiohttp: aliceio/client/session/aiohttp.md
99
                  - Мидлвари:
100
                      - Base: aliceio/client/session/middlewares/base.md
101
                      - Manager: aliceio/client/session/middlewares/manager.md
102
                      - RequestLogging: aliceio/client/session/middlewares/request-logging.md
103

104
      - Обработка событий:
105
          - Роутер: aliceio/dispatcher/router.md
106
          - Диспетчер: aliceio/dispatcher/dispatcher.md
107
          - Фильтрация:
108
              - Base: aliceio/filters/base.md
109
              - Состояния: aliceio/filters/state.md
110
              - Исключение: aliceio/filters/exception.md
111
              - Комбинации: aliceio/filters/logic.md
112
              - MagicData: aliceio/filters/magic-data.md
113
              - MagicFilter: aliceio/filters/magic-filter.md
114
          - Вебхук:
115
              - Aiohttp: aliceio/webhook/aiohttp-server.md
116
              - Security: aliceio/webhook/security.md
117
          - Машина состояний:
118
              - Контекст: aliceio/fsm/context.md
119
              - Состояние: aliceio/fsm/state.md
120
              - Стратегия: aliceio/fsm/strategy.md
121
              - Хранилища:
122
                  - Base: aliceio/fsm/storage/base.md
123
                  - MemoryStorage: aliceio/fsm/storage/memory.md
124
                  - ApiStorage: aliceio/fsm/storage/api.md
125
                  - Redis:
126
                      - RedisStorage: aliceio/fsm/storage/redis/redis.md
127
                      - DefaultKeyBuilder: aliceio/fsm/storage/redis/default-key-builder.md
128
                      - KeyBuilder: aliceio/fsm/storage/redis/key-builder.md
129
          - Мидлвари:
130
              - Base: aliceio/dispatcher/middlewares/base.md
131
          - Флаги: aliceio/dispatcher/flags.md
132
          - Class-based хэндлеры:
133
              - Base: aliceio/handlers/base.md
134
              - AudioPlayer: aliceio/handlers/audio-player.md
135
              - ButtonPressed: aliceio/handlers/button-pressed.md
136
              - Message: aliceio/handlers/message.md
137
              - Purchase: aliceio/handlers/purchase.md
138
              - ShowPull: aliceio/handlers/show-pull.md
139
              - Error: aliceio/handlers/error.md
140
              - Timeout: aliceio/handlers/timeout.md
141

142
      - Утилсы:
143
          - Билдеры:
144
              - Описание: aliceio/utils/builders.md
145
              - Base: aliceio/utils/builders/builder.md
146
              - ImageGalleryBuilder: aliceio/utils/builders/image-gallery-builder.md
147
              - ItemsListBuilder: aliceio/utils/builders/items-list-builder.md
148
              - TextButtonBuilder: aliceio/utils/builders/text-button-builder.md
149

150
      - Внутреннее устройство:
151
          - Наблюдатели:
152
              - Base: aliceio/dispatcher/event/bases.md
153
              - EventObserver: aliceio/dispatcher/event/event.md
154
              - AliceEventObserver: aliceio/dispatcher/event/alice.md
155
              - Handlers: aliceio/dispatcher/event/handler.md
156
          - Мидлвари:
157
              - Manager: aliceio/dispatcher/middlewares/manager.md
158
              - UserContext: aliceio/dispatcher/middlewares/user-context.md
159
              - Error: aliceio/dispatcher/middlewares/error.md
160
              - ResponseConvert: aliceio/dispatcher/middlewares/response-convert.md
161
              - FSMContextMiddleware: aliceio/fsm/middlewares/fsm-context.md
162
              - FSMApiStorageMiddleware: aliceio/fsm/middlewares/api-storage.md
163
          - Утилсы:
164
              - Funcs: aliceio/utils/funcs.md
165
              - Mixins: aliceio/utils/mixins.md
166
              - Warnings: aliceio/utils/warnings.md
167
      - Контрибьютинг: contributing.md
168

169
  - Туториал:
170
      - tutorial/index.md
171
      - Начало: tutorial/start.md
172
      - Первый навык: tutorial/first-skill.md
173
      - Методы API: tutorial/methods.md
174
      - Роутеры: tutorial/routers.md
175
      - Фильтры: tutorial/filters.md
176
      - Мидлвари: tutorial/middlewares.md
177
      - Машина состояний: tutorial/finite-state-machine.md
178
      - Кнопки и альбомы: tutorial/builders.md
179
      - Обработка ошибок: tutorial/error-handling.md
180
      - Особые события: tutorial/special-events.md
181
      - Внедрение зависимостей: tutorial/dependency-injection.md
182
      - Полноценный навык: tutorial/full-skill.md
183
      - FAQ: tutorial/faq.md
184

185

186
theme:
187
  name: material
188
  language: ru
189
  features:
190
    - navigation.instant
191
    - navigation.indexes
192
    - navigation.tracking
193
    - navigation.tabs
194
    - navigation.top
195
    - search.suggest
196
    - content.code.copy
197
  palette:
198
    - media: "(prefers-color-scheme: light)"
199
      scheme: default
200
      accent: blue
201
      toggle:
202
        icon: material/toggle-switch
203
        name: Switch to dark mode
204
    - media: "(prefers-color-scheme: dark)"
205
      scheme: slate
206
      accent: blue
207
      toggle:
208
        icon: material/toggle-switch-off-outline
209
        name: Switch to light mode
210
  font:
211
    text: Roboto Mono
212
    code: Monaco
213
  logo: _static/logo-aliceio-trans.png
214
  favicon: _static/logo-aliceio-trans.png
215

216

217
markdown_extensions:
218
  - attr_list:
219
  - admonition:
220
  - md_in_html:
221
  - pymdownx.magiclink:
222
      repo_url_shortener: true
223
      repo_url_shorthand: true
224
      normalize_issue_symbols: true
225
      user: K1rL3s
226
      repo: aliceio
227
  - pymdownx.highlight:
228
      anchor_linenums: true
229
      line_spans: __span
230
      pygments_lang_class: true
231
      linenums: true
232
      guess_lang: true
233
  - pymdownx.inlinehilite:
234
  - pymdownx.superfences:
235
  - pymdownx.tabbed:
236
      alternate_style: true
237
  - pymdownx.escapeall:
238
      hardbreak: True
239
      nbsp: True
240
  - pymdownx.details:
241
  - pymdownx.tabbed:
242
  - pymdownx.saneheaders:
243

244

245
plugins:
246
  - search:
247
  - mkdocstrings:
248
      custom_templates: docs/templates
249
      handlers:
250
        python:
251
          options:
252
            docstring_options:
253
              ignore_init_summary: false
254
              trim_doctest_flags: true
255
            docstring_section_style: list
256
            docstring_style: sphinx
257
            group_by_category: true
258
            show_docstring_description: true
259
            merge_init_into_class: false
260
            show_root_heading: true
261
            show_signature: true
262
            show_signature_annotations: true
263
            show_source: false
264
            show_symbol_type_heading: true
265
            show_symbol_type_toc: true
266

267

268
extra_css:
269
  - _css/style.css
270