diff --git a/.vs/Python_HW/FileContentIndex/bf645799-c9e5-45df-816d-b791fcb04273.vsidx b/.vs/Python_HW/FileContentIndex/bf645799-c9e5-45df-816d-b791fcb04273.vsidx deleted file mode 100644 index 46447c6..0000000 Binary files a/.vs/Python_HW/FileContentIndex/bf645799-c9e5-45df-816d-b791fcb04273.vsidx and /dev/null differ diff --git a/.vs/Python_HW/v17/.wsuo b/.vs/Python_HW/v17/.wsuo deleted file mode 100644 index 34cf23b..0000000 Binary files a/.vs/Python_HW/v17/.wsuo and /dev/null differ diff --git a/.vs/VSWorkspaceState.json b/.vs/VSWorkspaceState.json deleted file mode 100644 index 6b61141..0000000 --- a/.vs/VSWorkspaceState.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "ExpandedNodes": [ - "" - ], - "PreviewInSolutionExplorer": false -} \ No newline at end of file diff --git a/.vs/slnx.sqlite b/.vs/slnx.sqlite deleted file mode 100644 index 4e90117..0000000 Binary files a/.vs/slnx.sqlite and /dev/null differ diff --git a/README.md b/README.md index dd1707c..41d5e00 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,52 @@ -# advanced-python-homework-2023 -How to create virtual enviroment +## How to create virtual enviroment 1. Ensure you have the latest version of Python. Print +``` python --version +``` If you have the lattest version, go to the next step. Othervise download it from the oficcial website. + 2. Create a Virtual Enviroment. Open your terminal, choose your project directory, run the next command: +``` python -m venv . +``` + 3. Activate the Virtual Enviroment. +``` .\\Scripts\activate +``` + 4. Done. + Note: if you use Virtual Studio Code, you may not have the virtual enviroment name in the beggining of the string, but your project files become green. If you need to deactivate your Virtual Enviroment, print +``` deactivate +``` -How to create a documentation +## How to create a documentation 1. Open your project directory +``` cd +``` + 2. Print +``` sphinx-quickstart +``` + 3. Answer all questions that installator asks you -You can change all configurations in conf.py +You can change all configurations in `conf.py` + 4. Print -sphinx-build -b html source build\html \ No newline at end of file +``` +make html +``` +You can look at your documentation by running +``` +python -m http.server +``` diff --git a/Makefile b/docs/Makefile similarity index 100% rename from Makefile rename to docs/Makefile diff --git a/make.bat b/docs/make.bat similarity index 100% rename from make.bat rename to docs/make.bat diff --git a/source/conf.py b/docs/source/conf.py similarity index 100% rename from source/conf.py rename to docs/source/conf.py diff --git a/source/index.rst b/docs/source/index.rst similarity index 88% rename from source/index.rst rename to docs/source/index.rst index 8f54e2a..1157718 100644 --- a/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ .. SCADA-system documentation master file, created by - sphinx-quickstart on Fri Sep 29 00:25:58 2023. + sphinx-quickstart on Fri Sep 29 20:29:56 2023. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. diff --git a/hwvenv/requirements.txt b/hwvenv/requirements.txt deleted file mode 100644 index 2d33a31..0000000 --- a/hwvenv/requirements.txt +++ /dev/null @@ -1,3 +0,0 @@ -Sphinx -Pylint -MyPy \ No newline at end of file