advanced-python-homework-2023/README.md
vviora c91e3f4a1e new file: .controls/__init__.py
new file:   .vs/Python_HW/FileContentIndex/bf645799-c9e5-45df-816d-b791fcb04273.vsidx
	new file:   .vs/Python_HW/v17/.wsuo
    new file:   .vs/VSWorkspaceState.json
	new file:   .vs/slnx.sqlite
	new file:   LICENSE
	new file:   Makefile
	modified:   README.md
	new file:   hwvenv/Scripts/Activate.ps1
	new file:   hwvenv/Scripts/activate
    new file:   hwvenv/Scripts/activate.bat
	new file:   hwvenv/Scripts/deactivate.bat
	new file:   hwvenv/Scripts/pip.exe
	new file:   hwvenv/Scripts/pip3.11.exe
	new file:   hwvenv/Scripts/pip3.exe
	new file:   hwvenv/Scripts/python.exe
	new file:   hwvenv/Scripts/pythonw.exe
	new file:   hwvenv/pyvenv.cfg
	new file:   hwvenv/requirements.txt
	new file:   make.bat
	new file:   setup.py
	new file:   source/conf.py
	new file:   source/index.rst
2023-09-29 20:25:07 +03:00

53 lines
1004 B
Markdown

## 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
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`
4. Print
```
make html
```
You can look at your documentation by running
```
python -m http.server
```