From 98c17e18fac0825f8d30f25bc06662dc5f15cc84 Mon Sep 17 00:00:00 2001 From: SerKin0 <71343548+SerKin0@users.noreply.github.com> Date: Wed, 20 May 2026 13:31:53 +0300 Subject: [PATCH] =?UTF-8?q?[2]=20=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=BB?= =?UTF-8?q?=D0=B5=D0=BD=D0=B8=D0=B5=20=D0=B0=D0=B2=D1=82=D0=BE=20=D0=B4?= =?UTF-8?q?=D0=BE=D0=BA=D1=83=D0=BC=D0=B5=D0=BD=D1=82=D0=B0=D1=86=D0=B8?= =?UTF-8?q?=D0=B8=20=D0=BF=D1=80=D0=BE=D0=B5=D0=BA=D1=82=D0=B0=20=D0=B2?= =?UTF-8?q?=D1=82=D0=BE=D1=80=D0=BE=D0=B9=20=D0=BB=D0=B0=D0=B1=D0=BE=D1=80?= =?UTF-8?q?=D0=B0=D1=82=D0=BE=D1=80=D0=BD=D0=BE=D0=B9=20=D1=80=D0=B0=D0=B1?= =?UTF-8?q?=D0=BE=D1=82=D1=8B?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- skorohodovsa/task_2/docs/Makefile | 20 ++++++ skorohodovsa/task_2/docs/make.bat | 35 +++++++++++ skorohodovsa/task_2/docs/source/api.md | 9 +++ skorohodovsa/task_2/docs/source/conf.py | 78 ++++++++++++++++++++++++ skorohodovsa/task_2/docs/source/index.md | 5 ++ 5 files changed, 147 insertions(+) create mode 100644 skorohodovsa/task_2/docs/Makefile create mode 100644 skorohodovsa/task_2/docs/make.bat create mode 100644 skorohodovsa/task_2/docs/source/api.md create mode 100644 skorohodovsa/task_2/docs/source/conf.py create mode 100644 skorohodovsa/task_2/docs/source/index.md diff --git a/skorohodovsa/task_2/docs/Makefile b/skorohodovsa/task_2/docs/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/skorohodovsa/task_2/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/skorohodovsa/task_2/docs/make.bat b/skorohodovsa/task_2/docs/make.bat new file mode 100644 index 0000000..dc1312a --- /dev/null +++ b/skorohodovsa/task_2/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/skorohodovsa/task_2/docs/source/api.md b/skorohodovsa/task_2/docs/source/api.md new file mode 100644 index 0000000..f3eb868 --- /dev/null +++ b/skorohodovsa/task_2/docs/source/api.md @@ -0,0 +1,9 @@ +# API Reference + +## Модуль `models.map` + +```{eval-rst} +.. automodule:: models.map + :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 new file mode 100644 index 0000000..2d03d3f --- /dev/null +++ b/skorohodovsa/task_2/docs/source/conf.py @@ -0,0 +1,78 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# 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 sys +sys.path.insert(0, os.path.abspath('../..')) + + +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", # ::: блоки +] + +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', +] + +autosummary_generate = True + +autodoc_default_options = { + 'members': True, + 'undoc-members': True, + 'show-inheritance': True, + 'special-members': '__init__', + 'inherited-members': False, + 'exclude-members': '__weakref__', +} + +napoleon_google_docstring = True +napoleon_numpy_docstring = False +napoleon_include_init_with_doc = True +napoleon_include_private_with_doc = False + +# --- Тема --- +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': {}, +} + +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', +] + +# --- HTML --- +html_static_path = ["_static"] \ No newline at end of file diff --git a/skorohodovsa/task_2/docs/source/index.md b/skorohodovsa/task_2/docs/source/index.md new file mode 100644 index 0000000..03c974e --- /dev/null +++ b/skorohodovsa/task_2/docs/source/index.md @@ -0,0 +1,5 @@ +# Лабораторная работа "Поиск выхода из лабиринта" + +:::{toctree} +:maxdepth: 2 +api \ No newline at end of file