From e4a5c6d398789472bfda6f2c297cbe5d4fed8b3c Mon Sep 17 00:00:00 2001 From: kolo Date: Sat, 1 Nov 2025 11:38:48 +0300 Subject: [PATCH] docs --- .../{argparser_snippet.py => argparser/snippet.py} | 0 .../{argspace_snippet.py => argspace/snippet.py} | 0 .../{argspace_snippet2.py => argspace/snippet2.py} | 0 .../{argspace_snippet3.py => argspace/snippet3.py} | 0 .../snippet.py} | 0 .../{command_snippet.py => command/snippet.py} | 0 .../{command_snippet2.py => command/snippet2.py} | 0 .../{command_snippet3.py => command/snippet3.py} | 0 .../{command_snippet4.py => command/snippet4.py} | 0 .../snippet.py} | 0 .../snippet2.py} | 0 .../snippet3.py} | 0 .../snippet4.py} | 0 .../snippet.py} | 0 .../snippet.py} | 0 .../snippet2.py} | 0 .../snippet3.py} | 0 .../snippet4.py} | 0 .../snippet5.py} | 0 .../snippet6.py} | 0 .../predefined_flags.py} | 0 .../{flag_snippet.py => flag/snippet.py} | 0 .../{flag_snippet2.py => flag/snippet2.py} | 0 .../{flag_snippet3.py => flag/snippet3.py} | 0 .../{flag_snippet4.py => flag/snippet4.py} | 0 .../{flag_snippet5.py => flag/snippet5.py} | 0 .../{flag_snippet6.py => flag/snippet6.py} | 0 .../{flags_snippet.py => flags/snippet.py} | 0 .../{flags_snippet2.py => flags/snippet2.py} | 0 .../{flags_snippet3.py => flags/snippet3.py} | 0 .../{flags_snippet4.py => flags/snippet4.py} | 0 .../{flags_snippet5.py => flags/snippet5.py} | 0 .../{flags_snippet6.py => flags/snippet6.py} | 0 .../snippet1.py} | 0 .../snippet2.py} | 0 .../snippet3.py} | 0 .../snippet4.py} | 0 .../snippet5.py} | 0 .../snippet.py} | 0 .../sample.py} | 0 .../all.py} | 0 .../combined.py} | 0 .../neither.py} | 0 .../predefined.py} | 0 .../main.py} | 0 .../routers.py} | 0 .../sample.py} | 0 .../sample2.py} | 0 .../{router_snippet.py => router/snippet.py} | 0 .../comprehensive.py} | 0 .../input_flag.py} | 0 .../invalid.py} | 0 .../processing.py} | 0 .../undefined.py} | 0 .../valid.py} | 0 docs/root/api/app/autocompleter.rst | 2 +- docs/root/api/app/dividing_lines.rst | 2 +- docs/root/api/command/flag.rst | 12 ++++++------ docs/root/api/command/flags.rst | 12 ++++++------ docs/root/api/command/index.rst | 6 +++--- docs/root/api/command/input_flag.rst | 12 +++++++----- docs/root/api/command/possible_values.rst | 8 ++++---- docs/root/api/command/validation_status.rst | 6 +++--- docs/root/api/orchestrator/argparser.rst | 2 +- docs/root/api/orchestrator/argspace.rst | 6 +++--- docs/root/api/orchestrator/arguments.rst | 1 + docs/root/api/orchestrator/index.rst | 2 +- docs/root/api/router.rst | 2 +- docs/root/dependency_injection.rst | 8 ++++---- docs/root/error_handling.rst | 12 ++++++------ docs/root/overriding_formatting.rst | 2 +- docs/root/quickstart.rst | 4 ++-- docs/root/redirect_stdout.rst | 4 ++-- 73 files changed, 53 insertions(+), 50 deletions(-) rename docs/code_snippets/{argparser_snippet.py => argparser/snippet.py} (100%) rename docs/code_snippets/{argspace_snippet.py => argspace/snippet.py} (100%) rename docs/code_snippets/{argspace_snippet2.py => argspace/snippet2.py} (100%) rename docs/code_snippets/{argspace_snippet3.py => argspace/snippet3.py} (100%) rename docs/code_snippets/{autocompleter_snippet.py => autocompleter/snippet.py} (100%) rename docs/code_snippets/{command_snippet.py => command/snippet.py} (100%) rename docs/code_snippets/{command_snippet2.py => command/snippet2.py} (100%) rename docs/code_snippets/{command_snippet3.py => command/snippet3.py} (100%) rename docs/code_snippets/{command_snippet4.py => command/snippet4.py} (100%) rename docs/code_snippets/{dependency_injection_snippet.py => dependency_injection/snippet.py} (100%) rename docs/code_snippets/{dependency_injection_snippet2.py => dependency_injection/snippet2.py} (100%) rename docs/code_snippets/{dependency_injection_snippet3.py => dependency_injection/snippet3.py} (100%) rename docs/code_snippets/{dependency_injection_snippet4.py => dependency_injection/snippet4.py} (100%) rename docs/code_snippets/{dividing_lines_snippet.py => dividing_lines/snippet.py} (100%) rename docs/code_snippets/{error_handling_snippet.py => error_handling/snippet.py} (100%) rename docs/code_snippets/{error_handling_snippet2.py => error_handling/snippet2.py} (100%) rename docs/code_snippets/{error_handling_snippet3.py => error_handling/snippet3.py} (100%) rename docs/code_snippets/{error_handling_snippet4.py => error_handling/snippet4.py} (100%) rename docs/code_snippets/{error_handling_snippet5.py => error_handling/snippet5.py} (100%) rename docs/code_snippets/{error_handling_snippet6.py => error_handling/snippet6.py} (100%) rename docs/code_snippets/{predefined_flags_snippet.py => flag/predefined_flags.py} (100%) rename docs/code_snippets/{flag_snippet.py => flag/snippet.py} (100%) rename docs/code_snippets/{flag_snippet2.py => flag/snippet2.py} (100%) rename docs/code_snippets/{flag_snippet3.py => flag/snippet3.py} (100%) rename docs/code_snippets/{flag_snippet4.py => flag/snippet4.py} (100%) rename docs/code_snippets/{flag_snippet5.py => flag/snippet5.py} (100%) rename docs/code_snippets/{flag_snippet6.py => flag/snippet6.py} (100%) rename docs/code_snippets/{flags_snippet.py => flags/snippet.py} (100%) rename docs/code_snippets/{flags_snippet2.py => flags/snippet2.py} (100%) rename docs/code_snippets/{flags_snippet3.py => flags/snippet3.py} (100%) rename docs/code_snippets/{flags_snippet4.py => flags/snippet4.py} (100%) rename docs/code_snippets/{flags_snippet5.py => flags/snippet5.py} (100%) rename docs/code_snippets/{flags_snippet6.py => flags/snippet6.py} (100%) rename docs/code_snippets/{input_flag_snippet1.py => input_flag/snippet1.py} (100%) rename docs/code_snippets/{input_flag_snippet2.py => input_flag/snippet2.py} (100%) rename docs/code_snippets/{input_flag_snippet3.py => input_flag/snippet3.py} (100%) rename docs/code_snippets/{input_flag_snippet4.py => input_flag/snippet4.py} (100%) rename docs/code_snippets/{input_flag_snippet5.py => input_flag/snippet5.py} (100%) rename docs/code_snippets/{orchestrator_snippet.py => orchestrator/snippet.py} (100%) rename docs/code_snippets/{overriding_format_example_sample.py => overriding_formatting/sample.py} (100%) rename docs/code_snippets/{possible_values_all_snippet.py => possible_values/all.py} (100%) rename docs/code_snippets/{possible_values_combined_snippet.py => possible_values/combined.py} (100%) rename docs/code_snippets/{possible_values_neither_snippet.py => possible_values/neither.py} (100%) rename docs/code_snippets/{possible_values_predefined_snippet.py => possible_values/predefined.py} (100%) rename docs/code_snippets/{quickstart_example_main.py => quickstart/main.py} (100%) rename docs/code_snippets/{quickstart_example_routers.py => quickstart/routers.py} (100%) rename docs/code_snippets/{redirect_stdout_example_sample.py => redirect_stdout/sample.py} (100%) rename docs/code_snippets/{redirect_stdout_example_sample2.py => redirect_stdout/sample2.py} (100%) rename docs/code_snippets/{router_snippet.py => router/snippet.py} (100%) rename docs/code_snippets/{validation_status_comprehensive_snippet6.py => validation_status/comprehensive.py} (100%) rename docs/code_snippets/{validation_status_input_flag_snippet4.py => validation_status/input_flag.py} (100%) rename docs/code_snippets/{validation_status_invalid_snippet2.py => validation_status/invalid.py} (100%) rename docs/code_snippets/{validation_status_processing_snippet5.py => validation_status/processing.py} (100%) rename docs/code_snippets/{validation_status_undefined_snippet3.py => validation_status/undefined.py} (100%) rename docs/code_snippets/{validation_status_valid_snippet1.py => validation_status/valid.py} (100%) diff --git a/docs/code_snippets/argparser_snippet.py b/docs/code_snippets/argparser/snippet.py similarity index 100% rename from docs/code_snippets/argparser_snippet.py rename to docs/code_snippets/argparser/snippet.py diff --git a/docs/code_snippets/argspace_snippet.py b/docs/code_snippets/argspace/snippet.py similarity index 100% rename from docs/code_snippets/argspace_snippet.py rename to docs/code_snippets/argspace/snippet.py diff --git a/docs/code_snippets/argspace_snippet2.py b/docs/code_snippets/argspace/snippet2.py similarity index 100% rename from docs/code_snippets/argspace_snippet2.py rename to docs/code_snippets/argspace/snippet2.py diff --git a/docs/code_snippets/argspace_snippet3.py b/docs/code_snippets/argspace/snippet3.py similarity index 100% rename from docs/code_snippets/argspace_snippet3.py rename to docs/code_snippets/argspace/snippet3.py diff --git a/docs/code_snippets/autocompleter_snippet.py b/docs/code_snippets/autocompleter/snippet.py similarity index 100% rename from docs/code_snippets/autocompleter_snippet.py rename to docs/code_snippets/autocompleter/snippet.py diff --git a/docs/code_snippets/command_snippet.py b/docs/code_snippets/command/snippet.py similarity index 100% rename from docs/code_snippets/command_snippet.py rename to docs/code_snippets/command/snippet.py diff --git a/docs/code_snippets/command_snippet2.py b/docs/code_snippets/command/snippet2.py similarity index 100% rename from docs/code_snippets/command_snippet2.py rename to docs/code_snippets/command/snippet2.py diff --git a/docs/code_snippets/command_snippet3.py b/docs/code_snippets/command/snippet3.py similarity index 100% rename from docs/code_snippets/command_snippet3.py rename to docs/code_snippets/command/snippet3.py diff --git a/docs/code_snippets/command_snippet4.py b/docs/code_snippets/command/snippet4.py similarity index 100% rename from docs/code_snippets/command_snippet4.py rename to docs/code_snippets/command/snippet4.py diff --git a/docs/code_snippets/dependency_injection_snippet.py b/docs/code_snippets/dependency_injection/snippet.py similarity index 100% rename from docs/code_snippets/dependency_injection_snippet.py rename to docs/code_snippets/dependency_injection/snippet.py diff --git a/docs/code_snippets/dependency_injection_snippet2.py b/docs/code_snippets/dependency_injection/snippet2.py similarity index 100% rename from docs/code_snippets/dependency_injection_snippet2.py rename to docs/code_snippets/dependency_injection/snippet2.py diff --git a/docs/code_snippets/dependency_injection_snippet3.py b/docs/code_snippets/dependency_injection/snippet3.py similarity index 100% rename from docs/code_snippets/dependency_injection_snippet3.py rename to docs/code_snippets/dependency_injection/snippet3.py diff --git a/docs/code_snippets/dependency_injection_snippet4.py b/docs/code_snippets/dependency_injection/snippet4.py similarity index 100% rename from docs/code_snippets/dependency_injection_snippet4.py rename to docs/code_snippets/dependency_injection/snippet4.py diff --git a/docs/code_snippets/dividing_lines_snippet.py b/docs/code_snippets/dividing_lines/snippet.py similarity index 100% rename from docs/code_snippets/dividing_lines_snippet.py rename to docs/code_snippets/dividing_lines/snippet.py diff --git a/docs/code_snippets/error_handling_snippet.py b/docs/code_snippets/error_handling/snippet.py similarity index 100% rename from docs/code_snippets/error_handling_snippet.py rename to docs/code_snippets/error_handling/snippet.py diff --git a/docs/code_snippets/error_handling_snippet2.py b/docs/code_snippets/error_handling/snippet2.py similarity index 100% rename from docs/code_snippets/error_handling_snippet2.py rename to docs/code_snippets/error_handling/snippet2.py diff --git a/docs/code_snippets/error_handling_snippet3.py b/docs/code_snippets/error_handling/snippet3.py similarity index 100% rename from docs/code_snippets/error_handling_snippet3.py rename to docs/code_snippets/error_handling/snippet3.py diff --git a/docs/code_snippets/error_handling_snippet4.py b/docs/code_snippets/error_handling/snippet4.py similarity index 100% rename from docs/code_snippets/error_handling_snippet4.py rename to docs/code_snippets/error_handling/snippet4.py diff --git a/docs/code_snippets/error_handling_snippet5.py b/docs/code_snippets/error_handling/snippet5.py similarity index 100% rename from docs/code_snippets/error_handling_snippet5.py rename to docs/code_snippets/error_handling/snippet5.py diff --git a/docs/code_snippets/error_handling_snippet6.py b/docs/code_snippets/error_handling/snippet6.py similarity index 100% rename from docs/code_snippets/error_handling_snippet6.py rename to docs/code_snippets/error_handling/snippet6.py diff --git a/docs/code_snippets/predefined_flags_snippet.py b/docs/code_snippets/flag/predefined_flags.py similarity index 100% rename from docs/code_snippets/predefined_flags_snippet.py rename to docs/code_snippets/flag/predefined_flags.py diff --git a/docs/code_snippets/flag_snippet.py b/docs/code_snippets/flag/snippet.py similarity index 100% rename from docs/code_snippets/flag_snippet.py rename to docs/code_snippets/flag/snippet.py diff --git a/docs/code_snippets/flag_snippet2.py b/docs/code_snippets/flag/snippet2.py similarity index 100% rename from docs/code_snippets/flag_snippet2.py rename to docs/code_snippets/flag/snippet2.py diff --git a/docs/code_snippets/flag_snippet3.py b/docs/code_snippets/flag/snippet3.py similarity index 100% rename from docs/code_snippets/flag_snippet3.py rename to docs/code_snippets/flag/snippet3.py diff --git a/docs/code_snippets/flag_snippet4.py b/docs/code_snippets/flag/snippet4.py similarity index 100% rename from docs/code_snippets/flag_snippet4.py rename to docs/code_snippets/flag/snippet4.py diff --git a/docs/code_snippets/flag_snippet5.py b/docs/code_snippets/flag/snippet5.py similarity index 100% rename from docs/code_snippets/flag_snippet5.py rename to docs/code_snippets/flag/snippet5.py diff --git a/docs/code_snippets/flag_snippet6.py b/docs/code_snippets/flag/snippet6.py similarity index 100% rename from docs/code_snippets/flag_snippet6.py rename to docs/code_snippets/flag/snippet6.py diff --git a/docs/code_snippets/flags_snippet.py b/docs/code_snippets/flags/snippet.py similarity index 100% rename from docs/code_snippets/flags_snippet.py rename to docs/code_snippets/flags/snippet.py diff --git a/docs/code_snippets/flags_snippet2.py b/docs/code_snippets/flags/snippet2.py similarity index 100% rename from docs/code_snippets/flags_snippet2.py rename to docs/code_snippets/flags/snippet2.py diff --git a/docs/code_snippets/flags_snippet3.py b/docs/code_snippets/flags/snippet3.py similarity index 100% rename from docs/code_snippets/flags_snippet3.py rename to docs/code_snippets/flags/snippet3.py diff --git a/docs/code_snippets/flags_snippet4.py b/docs/code_snippets/flags/snippet4.py similarity index 100% rename from docs/code_snippets/flags_snippet4.py rename to docs/code_snippets/flags/snippet4.py diff --git a/docs/code_snippets/flags_snippet5.py b/docs/code_snippets/flags/snippet5.py similarity index 100% rename from docs/code_snippets/flags_snippet5.py rename to docs/code_snippets/flags/snippet5.py diff --git a/docs/code_snippets/flags_snippet6.py b/docs/code_snippets/flags/snippet6.py similarity index 100% rename from docs/code_snippets/flags_snippet6.py rename to docs/code_snippets/flags/snippet6.py diff --git a/docs/code_snippets/input_flag_snippet1.py b/docs/code_snippets/input_flag/snippet1.py similarity index 100% rename from docs/code_snippets/input_flag_snippet1.py rename to docs/code_snippets/input_flag/snippet1.py diff --git a/docs/code_snippets/input_flag_snippet2.py b/docs/code_snippets/input_flag/snippet2.py similarity index 100% rename from docs/code_snippets/input_flag_snippet2.py rename to docs/code_snippets/input_flag/snippet2.py diff --git a/docs/code_snippets/input_flag_snippet3.py b/docs/code_snippets/input_flag/snippet3.py similarity index 100% rename from docs/code_snippets/input_flag_snippet3.py rename to docs/code_snippets/input_flag/snippet3.py diff --git a/docs/code_snippets/input_flag_snippet4.py b/docs/code_snippets/input_flag/snippet4.py similarity index 100% rename from docs/code_snippets/input_flag_snippet4.py rename to docs/code_snippets/input_flag/snippet4.py diff --git a/docs/code_snippets/input_flag_snippet5.py b/docs/code_snippets/input_flag/snippet5.py similarity index 100% rename from docs/code_snippets/input_flag_snippet5.py rename to docs/code_snippets/input_flag/snippet5.py diff --git a/docs/code_snippets/orchestrator_snippet.py b/docs/code_snippets/orchestrator/snippet.py similarity index 100% rename from docs/code_snippets/orchestrator_snippet.py rename to docs/code_snippets/orchestrator/snippet.py diff --git a/docs/code_snippets/overriding_format_example_sample.py b/docs/code_snippets/overriding_formatting/sample.py similarity index 100% rename from docs/code_snippets/overriding_format_example_sample.py rename to docs/code_snippets/overriding_formatting/sample.py diff --git a/docs/code_snippets/possible_values_all_snippet.py b/docs/code_snippets/possible_values/all.py similarity index 100% rename from docs/code_snippets/possible_values_all_snippet.py rename to docs/code_snippets/possible_values/all.py diff --git a/docs/code_snippets/possible_values_combined_snippet.py b/docs/code_snippets/possible_values/combined.py similarity index 100% rename from docs/code_snippets/possible_values_combined_snippet.py rename to docs/code_snippets/possible_values/combined.py diff --git a/docs/code_snippets/possible_values_neither_snippet.py b/docs/code_snippets/possible_values/neither.py similarity index 100% rename from docs/code_snippets/possible_values_neither_snippet.py rename to docs/code_snippets/possible_values/neither.py diff --git a/docs/code_snippets/possible_values_predefined_snippet.py b/docs/code_snippets/possible_values/predefined.py similarity index 100% rename from docs/code_snippets/possible_values_predefined_snippet.py rename to docs/code_snippets/possible_values/predefined.py diff --git a/docs/code_snippets/quickstart_example_main.py b/docs/code_snippets/quickstart/main.py similarity index 100% rename from docs/code_snippets/quickstart_example_main.py rename to docs/code_snippets/quickstart/main.py diff --git a/docs/code_snippets/quickstart_example_routers.py b/docs/code_snippets/quickstart/routers.py similarity index 100% rename from docs/code_snippets/quickstart_example_routers.py rename to docs/code_snippets/quickstart/routers.py diff --git a/docs/code_snippets/redirect_stdout_example_sample.py b/docs/code_snippets/redirect_stdout/sample.py similarity index 100% rename from docs/code_snippets/redirect_stdout_example_sample.py rename to docs/code_snippets/redirect_stdout/sample.py diff --git a/docs/code_snippets/redirect_stdout_example_sample2.py b/docs/code_snippets/redirect_stdout/sample2.py similarity index 100% rename from docs/code_snippets/redirect_stdout_example_sample2.py rename to docs/code_snippets/redirect_stdout/sample2.py diff --git a/docs/code_snippets/router_snippet.py b/docs/code_snippets/router/snippet.py similarity index 100% rename from docs/code_snippets/router_snippet.py rename to docs/code_snippets/router/snippet.py diff --git a/docs/code_snippets/validation_status_comprehensive_snippet6.py b/docs/code_snippets/validation_status/comprehensive.py similarity index 100% rename from docs/code_snippets/validation_status_comprehensive_snippet6.py rename to docs/code_snippets/validation_status/comprehensive.py diff --git a/docs/code_snippets/validation_status_input_flag_snippet4.py b/docs/code_snippets/validation_status/input_flag.py similarity index 100% rename from docs/code_snippets/validation_status_input_flag_snippet4.py rename to docs/code_snippets/validation_status/input_flag.py diff --git a/docs/code_snippets/validation_status_invalid_snippet2.py b/docs/code_snippets/validation_status/invalid.py similarity index 100% rename from docs/code_snippets/validation_status_invalid_snippet2.py rename to docs/code_snippets/validation_status/invalid.py diff --git a/docs/code_snippets/validation_status_processing_snippet5.py b/docs/code_snippets/validation_status/processing.py similarity index 100% rename from docs/code_snippets/validation_status_processing_snippet5.py rename to docs/code_snippets/validation_status/processing.py diff --git a/docs/code_snippets/validation_status_undefined_snippet3.py b/docs/code_snippets/validation_status/undefined.py similarity index 100% rename from docs/code_snippets/validation_status_undefined_snippet3.py rename to docs/code_snippets/validation_status/undefined.py diff --git a/docs/code_snippets/validation_status_valid_snippet1.py b/docs/code_snippets/validation_status/valid.py similarity index 100% rename from docs/code_snippets/validation_status_valid_snippet1.py rename to docs/code_snippets/validation_status/valid.py diff --git a/docs/root/api/app/autocompleter.rst b/docs/root/api/app/autocompleter.rst index caf30b6..8910e58 100644 --- a/docs/root/api/app/autocompleter.rst +++ b/docs/root/api/app/autocompleter.rst @@ -46,6 +46,6 @@ AutoCompleter ``AutoCompleter`` передается как аргумент при инициализации `App`. -.. literalinclude:: ../../../code_snippets/autocompleter_snippet.py +.. literalinclude:: ../../../code_snippets/autocompleter/snippet.py :language: python :linenos: diff --git a/docs/root/api/app/dividing_lines.rst b/docs/root/api/app/dividing_lines.rst index aef77d1..92ec98c 100644 --- a/docs/root/api/app/dividing_lines.rst +++ b/docs/root/api/app/dividing_lines.rst @@ -70,6 +70,6 @@ Dividing Lines Пример конфигурации -------------------- -.. literalinclude:: ../../../code_snippets/dividing_lines_snippet.py +.. literalinclude:: ../../../code_snippets/dividing_lines/snippet.py :language: python :linenos: diff --git a/docs/root/api/command/flag.rst b/docs/root/api/command/flag.rst index 322bc74..f9b7be6 100644 --- a/docs/root/api/command/flag.rst +++ b/docs/root/api/command/flag.rst @@ -54,7 +54,7 @@ Flag **Пример использования:** -.. literalinclude:: ../../../code_snippets/flag_snippet.py +.. literalinclude:: ../../../code_snippets/flag/snippet.py :linenos: :language: python @@ -80,7 +80,7 @@ string_entity **Пример использования:** -.. literalinclude:: ../../../code_snippets/flag_snippet3.py +.. literalinclude:: ../../../code_snippets/flag/snippet3.py :linenos: :language: python @@ -103,7 +103,7 @@ __str__ **Пример использования:** -.. literalinclude:: ../../../code_snippets/flag_snippet4.py +.. literalinclude:: ../../../code_snippets/flag/snippet4.py :linenos: :language: python @@ -123,7 +123,7 @@ __repr__ **Пример использования:** -.. literalinclude:: ../../../code_snippets/flag_snippet5.py +.. literalinclude:: ../../../code_snippets/flag/snippet5.py :linenos: :language: python @@ -147,7 +147,7 @@ __eq__ **Пример использования:** -.. literalinclude:: ../../../code_snippets/flag_snippet6.py +.. literalinclude:: ../../../code_snippets/flag/snippet6.py :linenos: :language: python @@ -266,6 +266,6 @@ PredefinedFlags **Пример использования:** -.. literalinclude:: ../../../code_snippets/predefined_flags_snippet.py +.. literalinclude:: ../../../code_snippets/flag/predefined_flags.py :linenos: :language: python diff --git a/docs/root/api/command/flags.rst b/docs/root/api/command/flags.rst index ee8ff86..9abf3dd 100644 --- a/docs/root/api/command/flags.rst +++ b/docs/root/api/command/flags.rst @@ -37,7 +37,7 @@ Flags **Пример использования:** -.. literalinclude:: ../../../code_snippets/flags_snippet.py +.. literalinclude:: ../../../code_snippets/flags/snippet.py :linenos: :language: python @@ -63,7 +63,7 @@ add_flag **Пример использования:** -.. literalinclude:: ../../../code_snippets/flags_snippet2.py +.. literalinclude:: ../../../code_snippets/flags/snippet2.py :linenos: :language: python @@ -86,7 +86,7 @@ add_flags **Пример использования:** -.. literalinclude:: ../../../code_snippets/flags_snippet3.py +.. literalinclude:: ../../../code_snippets/flags/snippet3.py :linenos: :language: python @@ -109,7 +109,7 @@ get_flag_by_name **Пример использования:** -.. literalinclude:: ../../../code_snippets/flags_snippet4.py +.. literalinclude:: ../../../code_snippets/flags/snippet4.py :linenos: :language: python @@ -132,7 +132,7 @@ __iter__ **Пример использования:** -.. literalinclude:: ../../../code_snippets/flags_snippet5.py +.. literalinclude:: ../../../code_snippets/flags/snippet5.py :linenos: :language: python @@ -153,6 +153,6 @@ __getitem__ **Пример использования:** -.. literalinclude:: ../../../code_snippets/flags_snippet6.py +.. literalinclude:: ../../../code_snippets/flags/snippet6.py :linenos: :language: python diff --git a/docs/root/api/command/index.rst b/docs/root/api/command/index.rst index 098fd2e..15e2f26 100644 --- a/docs/root/api/command/index.rst +++ b/docs/root/api/command/index.rst @@ -50,7 +50,7 @@ Command **Пример использования:** -.. literalinclude:: ../../../code_snippets/command_snippet.py +.. literalinclude:: ../../../code_snippets/command/snippet.py :linenos: .. seealso :: @@ -65,12 +65,12 @@ Command **Базовый пример:** -.. literalinclude:: ../../../code_snippets/command_snippet2.py +.. literalinclude:: ../../../code_snippets/command/snippet2.py :linenos: **Команды с флагами:** -.. literalinclude:: ../../../code_snippets/command_snippet3.py +.. literalinclude:: ../../../code_snippets/command/snippet3.py :linenos: ----- diff --git a/docs/root/api/command/input_flag.rst b/docs/root/api/command/input_flag.rst index c465da3..8bb7421 100644 --- a/docs/root/api/command/input_flag.rst +++ b/docs/root/api/command/input_flag.rst @@ -39,10 +39,12 @@ InputFlag **Атрибуты:** .. py:attribute:: name + :no-index: Имя введённого флага в виде строки. .. py:attribute:: prefix + :no-index: Префикс флага. Один из: ``"-"``, ``"--"``, ``"---"``. @@ -56,7 +58,7 @@ InputFlag **Пример использования:** -.. literalinclude:: ../../../code_snippets/input_flag_snippet1.py +.. literalinclude:: ../../../code_snippets/input_flag/snippet1.py :linenos: :language: python @@ -82,7 +84,7 @@ string_entity **Пример использования:** -.. literalinclude:: ../../../code_snippets/input_flag_snippet2.py +.. literalinclude:: ../../../code_snippets/input_flag/snippet2.py :linenos: :language: python @@ -105,7 +107,7 @@ __str__ **Пример использования:** -.. literalinclude:: ../../../code_snippets/input_flag_snippet3.py +.. literalinclude:: ../../../code_snippets/input_flag/snippet3.py :linenos: :language: python @@ -125,7 +127,7 @@ __repr__ **Пример использования:** -.. literalinclude:: ../../../code_snippets/input_flag_snippet4.py +.. literalinclude:: ../../../code_snippets/input_flag/snippet4.py :linenos: :language: python @@ -149,6 +151,6 @@ __eq__ **Пример использования:** -.. literalinclude:: ../../../code_snippets/input_flag_snippet5.py +.. literalinclude:: ../../../code_snippets/input_flag/snippet5.py :linenos: :language: python diff --git a/docs/root/api/command/possible_values.rst b/docs/root/api/command/possible_values.rst index eadbd63..ca2bbff 100644 --- a/docs/root/api/command/possible_values.rst +++ b/docs/root/api/command/possible_values.rst @@ -45,7 +45,7 @@ NEITHER **Пример использования:** -.. literalinclude:: ../../../code_snippets/possible_values_neither_snippet.py +.. literalinclude:: ../../../code_snippets/possible_values/neither.py :linenos: :language: python @@ -72,7 +72,7 @@ ALL **Пример использования:** -.. literalinclude:: ../../../code_snippets/possible_values_all_snippet.py +.. literalinclude:: ../../../code_snippets/possible_values/all.py :linenos: :language: python @@ -95,7 +95,7 @@ ALL **Пример комбинированного использования:** -.. literalinclude:: ../../../code_snippets/possible_values_combined_snippet.py +.. literalinclude:: ../../../code_snippets/possible_values/combined.py :linenos: :language: python @@ -106,7 +106,7 @@ ALL Многие предопределенные флаги используют ``PossibleValues.NEITHER``: -.. literalinclude:: ../../../code_snippets/possible_values_predefined_snippet.py +.. literalinclude:: ../../../code_snippets/possible_values/predefined.py :linenos: :language: python diff --git a/docs/root/api/command/validation_status.rst b/docs/root/api/command/validation_status.rst index 878da57..cb2f054 100644 --- a/docs/root/api/command/validation_status.rst +++ b/docs/root/api/command/validation_status.rst @@ -45,7 +45,7 @@ VALID **Пример использования:** -.. literalinclude:: ../../../code_snippets/validation_status_valid_snippet1.py +.. literalinclude:: ../../../code_snippets/validation_status/valid.py :linenos: :language: python @@ -72,7 +72,7 @@ INVALID **Пример использования:** -.. literalinclude:: ../../../code_snippets/validation_status_invalid_snippet2.py +.. literalinclude:: ../../../code_snippets/validation_status/invalid.py :linenos: :language: python @@ -103,7 +103,7 @@ UNDEFINED Пример демонстрирует использование всех статусов в реальном сценарии: -.. literalinclude:: ../../../code_snippets/validation_status_comprehensive_snippet6.py +.. literalinclude:: ../../../code_snippets/validation_status/comprehensive.py :linenos: :language: python diff --git a/docs/root/api/orchestrator/argparser.rst b/docs/root/api/orchestrator/argparser.rst index e3303c3..11ad3a1 100644 --- a/docs/root/api/orchestrator/argparser.rst +++ b/docs/root/api/orchestrator/argparser.rst @@ -47,7 +47,7 @@ ArgParser Пример использования -------------------- -.. literalinclude:: ../../../code_snippets/argparser_snippet.py +.. literalinclude:: ../../../code_snippets/argparser/snippet.py :language: python :linenos: diff --git a/docs/root/api/orchestrator/argspace.rst b/docs/root/api/orchestrator/argspace.rst index e517167..472ba0d 100644 --- a/docs/root/api/orchestrator/argspace.rst +++ b/docs/root/api/orchestrator/argspace.rst @@ -85,7 +85,7 @@ get_by_type **Пример использования:** -.. literalinclude:: ../../../code_snippets/argspace_snippet3.py +.. literalinclude:: ../../../code_snippets/argspace/snippet3.py :linenos: ----- @@ -105,12 +105,12 @@ InputArgument **Полный пример:** -.. literalinclude:: ../../../code_snippets/argspace_snippet.py +.. literalinclude:: ../../../code_snippets/argspace/snippet.py :linenos: Доступ к аргументам из хэндлеров осуществляется с помощью ``di``, подробнее :ref:`тут `. -.. literalinclude:: ../../../code_snippets/argspace_snippet2.py +.. literalinclude:: ../../../code_snippets/argspace/snippet2.py :linenos: **Запуск приложения:** diff --git a/docs/root/api/orchestrator/arguments.rst b/docs/root/api/orchestrator/arguments.rst index 1a98887..b582699 100644 --- a/docs/root/api/orchestrator/arguments.rst +++ b/docs/root/api/orchestrator/arguments.rst @@ -169,6 +169,7 @@ InputArgument **Атрибуты:** .. py:attribute:: name + :no-index: Имя аргумента в виде строки. Соответствует имени, указанному при создании ``ValueArgument`` или ``BooleanArgument``. diff --git a/docs/root/api/orchestrator/index.rst b/docs/root/api/orchestrator/index.rst index 3475fe9..b3300d3 100644 --- a/docs/root/api/orchestrator/index.rst +++ b/docs/root/api/orchestrator/index.rst @@ -62,7 +62,7 @@ Orchestrator Пример использования -------------------- -.. literalinclude:: ../../../code_snippets/orchestrator_snippet.py +.. literalinclude:: ../../../code_snippets/orchestrator/snippet.py :language: python .. toctree:: diff --git a/docs/root/api/router.rst b/docs/root/api/router.rst index 366cfc7..fd3900d 100644 --- a/docs/root/api/router.rst +++ b/docs/root/api/router.rst @@ -38,7 +38,7 @@ Router **Пример использования:** - .. literalinclude:: ../../code_snippets/router_snippet.py + .. literalinclude:: ../../code_snippets/router/snippet.py :linenos: :language: python diff --git a/docs/root/dependency_injection.rst b/docs/root/dependency_injection.rst index c9c8e88..5118f53 100644 --- a/docs/root/dependency_injection.rst +++ b/docs/root/dependency_injection.rst @@ -18,19 +18,19 @@ .. note:: ``argenta.di.FromDishka`` это алиас к ``dishka.FromDishka``, они полностью взаимозаменяемы. -.. literalinclude:: ../code_snippets/dependency_injection_snippet.py +.. literalinclude:: ../code_snippets/dependency_injection/snippet.py :language: python :linenos: ``Argenta`` -> ``dishka`` зарезолвит тайпхинты и внедрит зависимость с возвращаемым типом ``Connection``, прежде чем использовать зависимость её нужно создать, для этого нужно создать соответствующий провайдер. -.. literalinclude:: ../code_snippets/dependency_injection_snippet2.py +.. literalinclude:: ../code_snippets/dependency_injection/snippet2.py :language: python :linenos: После создания провайдера, его нужно зарегистрировать в оркестраторе. -.. literalinclude:: ../code_snippets/dependency_injection_snippet3.py +.. literalinclude:: ../code_snippets/dependency_injection/snippet3.py :language: python :linenos: @@ -49,7 +49,7 @@ Краткий сэмпл кода, который получает объект ``ArgSpace`` и выводит в консоль аргумент с именем "type": -.. literalinclude:: ../code_snippets/dependency_injection_snippet4.py +.. literalinclude:: ../code_snippets/dependency_injection/snippet4.py :language: python :linenos: diff --git a/docs/root/error_handling.rst b/docs/root/error_handling.rst index 8c967cc..b6d117b 100644 --- a/docs/root/error_handling.rst +++ b/docs/root/error_handling.rst @@ -17,7 +17,7 @@ Краткий сэмпл кода, переопределяющего хэндлер ввода пустой команды -.. literalinclude:: ../code_snippets/error_handling_snippet.py +.. literalinclude:: ../code_snippets/error_handling/snippet.py :language: python :linenos: @@ -46,7 +46,7 @@ Сэмпл кода, переопределяющего хэндлер ввода команды с некорректным синтаксисом: -.. literalinclude:: ../code_snippets/error_handling_snippet2.py +.. literalinclude:: ../code_snippets/error_handling/snippet2.py :language: python :linenos: @@ -73,7 +73,7 @@ Сэмпл кода, переопределяющего хэндлер ввода команды с повторяющимися флагами: -.. literalinclude:: ../code_snippets/error_handling_snippet3.py +.. literalinclude:: ../code_snippets/error_handling/snippet3.py :language: python :linenos: @@ -96,7 +96,7 @@ Сэмпл кода, переопределяющего хэндлер ввода пустой команды: -.. literalinclude:: ../code_snippets/error_handling_snippet4.py +.. literalinclude:: ../code_snippets/error_handling/snippet4.py :language: python :linenos: @@ -120,7 +120,7 @@ Сэмпл кода, переопределяющего хэндлер ввода неизвестной команды: -.. literalinclude:: ../code_snippets/error_handling_snippet5.py +.. literalinclude:: ../code_snippets/error_handling/snippet5.py :language: python :linenos: @@ -143,6 +143,6 @@ Сэмпл кода, переопределяющего хэндлер ввода команды выхода: -.. literalinclude:: ../code_snippets/error_handling_snippet6.py +.. literalinclude:: ../code_snippets/error_handling/snippet6.py :language: python :linenos: diff --git a/docs/root/overriding_formatting.rst b/docs/root/overriding_formatting.rst index df7e4c3..cf3544f 100644 --- a/docs/root/overriding_formatting.rst +++ b/docs/root/overriding_formatting.rst @@ -39,6 +39,6 @@ Пример использования -------------------- -.. literalinclude:: ../code_snippets/overriding_format_example_sample.py +.. literalinclude:: ../code_snippets/overriding_formatting/sample.py :language: python :linenos: diff --git a/docs/root/quickstart.rst b/docs/root/quickstart.rst index a2e881e..135674f 100644 --- a/docs/root/quickstart.rst +++ b/docs/root/quickstart.rst @@ -11,13 +11,13 @@ 2. **Определение роутера и хэндлеров**. За регистрацию функции как обработчика отвечает декоратор ``@router.command``, хэндлер всегда должен принимать аргумент с типом ``Response``, подробнее в :ref:`разделе `. -.. literalinclude:: ../code_snippets/quickstart_example_routers.py +.. literalinclude:: ../code_snippets/quickstart/routers.py :language: python :linenos: 3. **Определение приложения и оркестратора**. Для запуска приложения необходимо вызвать ``.include_router()`` у созданного приложения и передать ему раннее созданный роутер, после этого необходимо вызвать ``.start_polling()`` у созданного оркестратора и передать ему созданное приложение. -.. literalinclude:: ../code_snippets/quickstart_example_main.py +.. literalinclude:: ../code_snippets/quickstart/main.py :language: python :linenos: diff --git a/docs/root/redirect_stdout.rst b/docs/root/redirect_stdout.rst index 8637180..580cab6 100644 --- a/docs/root/redirect_stdout.rst +++ b/docs/root/redirect_stdout.rst @@ -43,7 +43,7 @@ Если при создании роутера установить ``disable_redirect_stdout=True``, то для всех команд этого роутера механизм перехвата ``stdout`` будет отключен. -.. literalinclude:: ../code_snippets/redirect_stdout_example_sample.py +.. literalinclude:: ../code_snippets/redirect_stdout/sample.py :language: python :linenos: @@ -69,7 +69,7 @@ Вы можете глобально задать тип разделительной линии для всего приложения через аргумент ``dividing_line`` в конструкторе ``App``. -.. literalinclude:: ../code_snippets/redirect_stdout_example_sample2.py +.. literalinclude:: ../code_snippets/redirect_stdout/sample2.py :language: python :linenos: