diff --git a/docs/conf.py b/docs/conf.py index 5a84b8c..9e754a8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -17,10 +17,6 @@ root_doc = "index" locale_dirs = ['locales/'] gettext_compact = False -extensions = [ - "sphinx.ext.graphviz" -] - templates_path = ["_templates"] exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] diff --git a/docs/index.rst b/docs/index.rst index c92e9cf..336f9a9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -32,7 +32,8 @@ Argenta предназначена для создания приложений, Следующая диаграмма иллюстрирует, как компоненты Argenta взаимодействуют друг с другом, обрабатывая ввод пользователя. .. image:: https://i.ibb.co/hF3FdFr1/argenta-intro-drawio-2.png - :alt: Архитектура Argenta + :alt: Request Lifecycle Diagram + :align: center .. toctree:: :hidden: diff --git a/docs/root/api/app/index.rst b/docs/root/api/app/index.rst index 824296e..2c0e266 100644 --- a/docs/root/api/app/index.rst +++ b/docs/root/api/app/index.rst @@ -67,10 +67,13 @@ App :param routers: Последовательность экземпляров ``Router`` для регистрации. - .. py:method:: add_message_on_startup(self, message: str) -> None - + Добавляет текстовое сообщение, которое выводится при запуске приложения после `initial_message`. - + :param message: Строка с сообщением. + + .. seealso:: + Для вывода стандартных сообщений можно использовать готовые шаблоны из :ref:`PredefinedMessages `. ----- @@ -135,3 +138,42 @@ App autocompleter dividing_lines + +----- + +.. _root_api_predefined_messages: + +PredefinedMessages +------------------ + +`PredefinedMessages` — это перечисление (Enum), содержащее набор готовых к использованию строковых сообщений. Они отформатированы с использованием синтаксиса `rich` и предназначены для вывода стандартной информации, такой как подсказки по использованию. + +Вы можете импортировать и использовать их напрямую в своих обработчиках. + +.. code-block:: python + :linenos: + + from argenta.app import PredefinedMessages + + def my_handler(response): + print(PredefinedMessages.USAGE) + +.. py:class:: PredefinedMessages + + .. py:attribute:: USAGE + + Строка: ``[b dim]Usage[/b dim]: [i] <[green]flags[/green]>[/i]`` + + Отображается как: ``Usage: `` + + .. py:attribute:: HELP + + Строка: ``[b dim]Help[/b dim]: [i][/i] [b red]--help[/b red]`` + + Отображается как: ``Help: --help`` + + .. py:attribute:: AUTOCOMPLETE + + Строка: ``[b dim]Autocomplete[/b dim]: [i][/i] [bold]`` + + Отображается как: ``Autocomplete: `` diff --git a/docs/root/api/index.rst b/docs/root/api/index.rst index 96a7526..e8be5b1 100644 --- a/docs/root/api/index.rst +++ b/docs/root/api/index.rst @@ -95,5 +95,4 @@ router orchestrator/index command/index - response - \ No newline at end of file + response \ No newline at end of file diff --git a/docs/root/flags.rst b/docs/root/flags.rst index 22dae5f..f2c2d68 100644 --- a/docs/root/flags.rst +++ b/docs/root/flags.rst @@ -37,8 +37,6 @@ Вы можете заранее определить список допустимых значений для флага. -**Пример:** - Предположим, у вас есть флаг ``--format``, который может принимать только значения ``json`` или ``xml``. .. code-block:: bash @@ -57,8 +55,6 @@ Для более сложных проверок можно использовать регулярные выражения. Это полезно, когда значение должно соответствовать определённому формату (например, email-адрес, дата или номер телефона). -**Пример:** - Допустим, флаг ``--email`` должен принимать только корректные email-адреса. .. code-block:: bash