Merge pull request 'main_local' (#2) from main_local into main
Reviewed-on: vviora/vviora_advanced-python-homework-2023#2
This commit is contained in:
commit
cc7fc3eda2
Binary file not shown.
Binary file not shown.
@ -1,6 +0,0 @@
|
||||
{
|
||||
"ExpandedNodes": [
|
||||
""
|
||||
],
|
||||
"PreviewInSolutionExplorer": false
|
||||
}
|
BIN
.vs/slnx.sqlite
BIN
.vs/slnx.sqlite
Binary file not shown.
34
README.md
34
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 .<venv_name>
|
||||
```
|
||||
|
||||
3. Activate the Virtual Enviroment.
|
||||
```
|
||||
.\<venv_name>\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 <path>
|
||||
```
|
||||
|
||||
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
|
||||
```
|
||||
make html
|
||||
```
|
||||
You can look at your documentation by running
|
||||
```
|
||||
python -m http.server
|
||||
```
|
||||
|
@ -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.
|
||||
|
@ -1,3 +0,0 @@
|
||||
Sphinx
|
||||
Pylint
|
||||
MyPy
|
Loading…
Reference in New Issue
Block a user