From 4700cded060b86da8165b45fc3ebac17aa3905f8 Mon Sep 17 00:00:00 2001
From: ermakov-ad <ermakovalexey2002@mail.ru>
Date: Fri, 29 Sep 2023 15:12:30 +0300
Subject: [PATCH] =?UTF-8?q?=D0=97=D0=B0=D0=B3=D1=80=D1=83=D0=B7=D0=B8?=
 =?UTF-8?q?=D1=82=D1=8C=20=D1=84=D0=B0=D0=B9=D0=BB=D1=8B=20=D0=B2=20=C2=AB?=
 =?UTF-8?q?1=5Fhw/docs=C2=BB?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 1_hw/docs/Makefile  | 20 ++++++++++++++++++++
 1_hw/docs/conf.py   | 28 ++++++++++++++++++++++++++++
 1_hw/docs/index.rst | 29 +++++++++++++++++++++++++++++
 1_hw/docs/make.bat  | 35 +++++++++++++++++++++++++++++++++++
 1_hw/docs/views.rst |  6 ++++++
 5 files changed, 118 insertions(+)
 create mode 100644 1_hw/docs/Makefile
 create mode 100644 1_hw/docs/conf.py
 create mode 100644 1_hw/docs/index.rst
 create mode 100644 1_hw/docs/make.bat
 create mode 100644 1_hw/docs/views.rst

diff --git a/1_hw/docs/Makefile b/1_hw/docs/Makefile
new file mode 100644
index 0000000..d0c3cbf
--- /dev/null
+++ b/1_hw/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/1_hw/docs/conf.py b/1_hw/docs/conf.py
new file mode 100644
index 0000000..9dae4bd
--- /dev/null
+++ b/1_hw/docs/conf.py
@@ -0,0 +1,28 @@
+# 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
+
+project = 'controls_Ermakov'
+copyright = '2023, Ermakov Alexey'
+author = 'Ermakov Alexey'
+release = '0.0.1'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = []
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+language = 'python3'
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_static_path = ['_static']
diff --git a/1_hw/docs/index.rst b/1_hw/docs/index.rst
new file mode 100644
index 0000000..3e13e90
--- /dev/null
+++ b/1_hw/docs/index.rst
@@ -0,0 +1,29 @@
+.. controls_Ermakov documentation master file, created by
+   sphinx-quickstart on Fri Sep 29 17:02:16 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to controls_Ermakov's documentation!
+============================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+Documentation myproject
+======================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: example of automatic-generative docs views
+
+   ./views.rst
\ No newline at end of file
diff --git a/1_hw/docs/make.bat b/1_hw/docs/make.bat
new file mode 100644
index 0000000..747ffb7
--- /dev/null
+++ b/1_hw/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/1_hw/docs/views.rst b/1_hw/docs/views.rst
new file mode 100644
index 0000000..8cb38b7
--- /dev/null
+++ b/1_hw/docs/views.rst
@@ -0,0 +1,6 @@
+Views
+=====
+
+.. automodule:: test_app.views
+   :members:
+   :undoc-members:
\ No newline at end of file