Merge pull request 'main_local' (#2) from main_local into main

Reviewed-on: #2
This commit is contained in:
vviora 2023-09-29 20:49:12 +03:00
commit cc7fc3eda2
10 changed files with 30 additions and 15 deletions

Binary file not shown.

View File

@ -1,6 +0,0 @@
{
"ExpandedNodes": [
""
],
"PreviewInSolutionExplorer": false
}

Binary file not shown.

View File

@ -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. 1. Ensure you have the latest version of Python.
Print Print
```
python --version python --version
```
If you have the lattest version, go to the next step. Othervise download it from the oficcial website. If you have the lattest version, go to the next step. Othervise download it from the oficcial website.
2. Create a Virtual Enviroment. 2. Create a Virtual Enviroment.
Open your terminal, choose your project directory, run the next command: Open your terminal, choose your project directory, run the next command:
```
python -m venv .<venv_name> python -m venv .<venv_name>
```
3. Activate the Virtual Enviroment. 3. Activate the Virtual Enviroment.
```
.\<venv_name>\Scripts\activate .\<venv_name>\Scripts\activate
```
4. Done. 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. 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 If you need to deactivate your Virtual Enviroment, print
```
deactivate deactivate
```
How to create a documentation ## How to create a documentation
1. Open your project directory 1. Open your project directory
```
cd <path> cd <path>
```
2. Print 2. Print
```
sphinx-quickstart sphinx-quickstart
```
3. Answer all questions that installator asks you 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 4. Print
sphinx-build -b html source build\html ```
make html
```
You can look at your documentation by running
```
python -m http.server
```

View File

@ -1,5 +1,5 @@
.. SCADA-system documentation master file, created by .. 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 You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.

View File

@ -1,3 +0,0 @@
Sphinx
Pylint
MyPy