From 5378824649cb11be2e15ff04f19efb76d8db79a2 Mon Sep 17 00:00:00 2001
From: SerKin0 <71343548+SerKin0@users.noreply.github.com>
Date: Sun, 24 May 2026 17:17:48 +0300
Subject: [PATCH] =?UTF-8?q?[2]=20=D0=9E=D0=B1=D0=BD=D0=BE=D0=B2=D0=BB?=
=?UTF-8?q?=D0=B5=D0=BD=D0=B8=D0=B5=20=D0=B4=D0=BE=D0=BA=D1=83=D0=BC=D0=B5?=
=?UTF-8?q?=D0=BD=D1=82=D0=B0=D1=86=D0=B8=D0=B8:=20-=20=D0=94=D0=BE=D0=B1?=
=?UTF-8?q?=D0=B0=D0=B2=D0=BB=D0=B5=D0=BD=D1=8B=20=D1=80=D0=B0=D0=B7=D0=B4?=
=?UTF-8?q?=D0=B5=D0=BB=D1=8B=20=D0=BF=D1=80=D0=BE=20=D0=B0=D0=BB=D0=B3?=
=?UTF-8?q?=D0=BE=D1=80=D0=B8=D1=82=D0=BC=D1=8B?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
skorohodovsa/task_2/docs/source/api.md | 33 +++++++--
skorohodovsa/task_2/docs/source/conf.py | 67 ++++++++++---------
.../task_2/docs/source/naming_maze.md | 7 +-
3 files changed, 64 insertions(+), 43 deletions(-)
diff --git a/skorohodovsa/task_2/docs/source/api.md b/skorohodovsa/task_2/docs/source/api.md
index 84f80d7..58caf5f 100644
--- a/skorohodovsa/task_2/docs/source/api.md
+++ b/skorohodovsa/task_2/docs/source/api.md
@@ -1,9 +1,34 @@
# API Reference
-## Модуль `models.base`
+## Базовые модели
-```{eval-rst}
-.. automodule:: models.base
+````{eval-rst}
+.. automodule:: source.models.base
:members:
:undoc-members:
- :show-inheritance:
\ No newline at end of file
+ :show-inheritance:
+````
+
+## Стратегии поиска пути
+
+````{eval-rst}
+.. automodule:: source.strategy.algorithms
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+.. automodule:: source.strategy.bfs
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+.. automodule:: source.strategy.dfs
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+.. automodule:: source.strategy.astar
+ :members:
+ :undoc-members:
+ :show-inheritance:
+````
\ No newline at end of file
diff --git a/skorohodovsa/task_2/docs/source/conf.py b/skorohodovsa/task_2/docs/source/conf.py
index 2d03d3f..4eeb0f1 100644
--- a/skorohodovsa/task_2/docs/source/conf.py
+++ b/skorohodovsa/task_2/docs/source/conf.py
@@ -7,44 +7,45 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
import os
import sys
-sys.path.insert(0, os.path.abspath('../..'))
+
+sys.path.insert(0, os.path.abspath("../.."))
-project = 'Поиск выхода из лабиринта'
-copyright = '2026, SerKin0'
-author = 'SerKin0'
-release = '0.0.1'
+project = "Поиск выхода из лабиринта"
+copyright = "2026, SerKin0"
+author = "SerKin0"
+release = "0.0.1"
html_title = project
# --- MyST (Markdown) ---
myst_enable_extensions = [
- "dollarmath", # $x$ и $$x$$
- "amsmath", # \begin{equation}
- "colon_fence", # ::: блоки
+ "dollarmath", # $x$ и $$x$$
+ "amsmath", # \begin{equation}
+ "colon_fence", # ::: блоки
]
-exclude_patterns = ['build', 'draft.md']
+exclude_patterns = ["build", "draft.md"]
extensions = [
- 'sphinx.ext.autodoc',
- 'sphinx.ext.napoleon',
- 'sphinx.ext.viewcode',
- 'myst_nb',
- 'sphinx.ext.mathjax',
- 'sphinx_new_tab_link',
- 'sphinx.ext.autosummary',
+ "sphinx.ext.autodoc",
+ "sphinx.ext.napoleon",
+ "sphinx.ext.viewcode",
+ "myst_nb",
+ "sphinx.ext.mathjax",
+ "sphinx_new_tab_link",
+ "sphinx.ext.autosummary",
]
autosummary_generate = True
autodoc_default_options = {
- 'members': True,
- 'undoc-members': True,
- 'show-inheritance': True,
- 'special-members': '__init__',
- 'inherited-members': False,
- 'exclude-members': '__weakref__',
+ "members": True,
+ "undoc-members": True,
+ "show-inheritance": True,
+ "special-members": "__init__",
+ "inherited-members": False,
+ "exclude-members": "__weakref__",
}
napoleon_google_docstring = True
@@ -53,26 +54,26 @@ napoleon_include_init_with_doc = True
napoleon_include_private_with_doc = False
# --- Тема ---
-html_permalinks_icon = '#'
-html_theme = 'sphinxawesome_theme'
+html_permalinks_icon = "#"
+html_theme = "sphinxawesome_theme"
language = "ru"
html_theme_options = {
- 'navigation_with_keys': True,
- 'globaltoc_collapse': False,
- 'globaltoc_includehidden': False,
- 'show_prev_next': True,
- 'main_nav_links': {},
+ "navigation_with_keys": True,
+ "globaltoc_collapse": False,
+ "globaltoc_includehidden": False,
+ "show_prev_next": True,
+ "main_nav_links": {},
}
-pygments_style = 'monokai'
-pygments_style_dark = 'monokai'
+pygments_style = "monokai"
+pygments_style_dark = "monokai"
# Для подключения CSS (стили иконок)
html_css_files = [
- 'https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0-beta3/css/all.min.css',
+ "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0-beta3/css/all.min.css",
]
# --- HTML ---
-html_static_path = ["_static"]
\ No newline at end of file
+html_static_path = ["_static"]
diff --git a/skorohodovsa/task_2/docs/source/naming_maze.md b/skorohodovsa/task_2/docs/source/naming_maze.md
index 79b9071..11b4e13 100644
--- a/skorohodovsa/task_2/docs/source/naming_maze.md
+++ b/skorohodovsa/task_2/docs/source/naming_maze.md
@@ -1,11 +1,6 @@
# Этап 2. Загрузка лабиринта из файла
-Во втором этапе разработки необходимо реализовать загрузку лабиринта из текстового файла, где:
-
-- `#` – стена;
-- ` ` – проход;
-- `S` – старт;
-- `E` – выход.
+Во втором этапе разработки необходимо реализовать загрузку лабиринта из текстового файла, где: `#` – стена, ` ` – проход, `S` – старт, `E` – выход.
## Систематизация файлов