[2] Обновление документации:

- Добавлены разделы про алгоритмы
This commit is contained in:
SerKin0 2026-05-24 17:17:48 +03:00
parent f7577f803c
commit 5378824649
3 changed files with 64 additions and 43 deletions

View File

@ -1,9 +1,34 @@
# API Reference # API Reference
## Модуль `models.base` ## Базовые модели
```{eval-rst} ````{eval-rst}
.. automodule:: models.base .. automodule:: source.models.base
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :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:
````

View File

@ -7,13 +7,14 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
import os import os
import sys import sys
sys.path.insert(0, os.path.abspath('../..'))
sys.path.insert(0, os.path.abspath("../.."))
project = 'Поиск выхода из лабиринта' project = "Поиск выхода из лабиринта"
copyright = '2026, SerKin0' copyright = "2026, SerKin0"
author = 'SerKin0' author = "SerKin0"
release = '0.0.1' release = "0.0.1"
html_title = project html_title = project
@ -24,27 +25,27 @@ myst_enable_extensions = [
"colon_fence", # ::: блоки "colon_fence", # ::: блоки
] ]
exclude_patterns = ['build', 'draft.md'] exclude_patterns = ["build", "draft.md"]
extensions = [ extensions = [
'sphinx.ext.autodoc', "sphinx.ext.autodoc",
'sphinx.ext.napoleon', "sphinx.ext.napoleon",
'sphinx.ext.viewcode', "sphinx.ext.viewcode",
'myst_nb', "myst_nb",
'sphinx.ext.mathjax', "sphinx.ext.mathjax",
'sphinx_new_tab_link', "sphinx_new_tab_link",
'sphinx.ext.autosummary', "sphinx.ext.autosummary",
] ]
autosummary_generate = True autosummary_generate = True
autodoc_default_options = { autodoc_default_options = {
'members': True, "members": True,
'undoc-members': True, "undoc-members": True,
'show-inheritance': True, "show-inheritance": True,
'special-members': '__init__', "special-members": "__init__",
'inherited-members': False, "inherited-members": False,
'exclude-members': '__weakref__', "exclude-members": "__weakref__",
} }
napoleon_google_docstring = True napoleon_google_docstring = True
@ -53,25 +54,25 @@ napoleon_include_init_with_doc = True
napoleon_include_private_with_doc = False napoleon_include_private_with_doc = False
# --- Тема --- # --- Тема ---
html_permalinks_icon = '<span>#</span>' html_permalinks_icon = "<span>#</span>"
html_theme = 'sphinxawesome_theme' html_theme = "sphinxawesome_theme"
language = "ru" language = "ru"
html_theme_options = { html_theme_options = {
'navigation_with_keys': True, "navigation_with_keys": True,
'globaltoc_collapse': False, "globaltoc_collapse": False,
'globaltoc_includehidden': False, "globaltoc_includehidden": False,
'show_prev_next': True, "show_prev_next": True,
'main_nav_links': {}, "main_nav_links": {},
} }
pygments_style = 'monokai' pygments_style = "monokai"
pygments_style_dark = 'monokai' pygments_style_dark = "monokai"
# Для подключения CSS (стили иконок) # Для подключения CSS (стили иконок)
html_css_files = [ 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 ---

View File

@ -1,11 +1,6 @@
# Этап 2. Загрузка лабиринта из файла # Этап 2. Загрузка лабиринта из файла
Во втором этапе разработки необходимо реализовать загрузку лабиринта из текстового файла, где: Во втором этапе разработки необходимо реализовать загрузку лабиринта из текстового файла, где: `#` стена, ` ` проход, `S` старт, `E` выход.
- `#` стена;
- ` ` проход;
- `S` старт;
- `E` выход.
## Систематизация файлов ## Систематизация файлов