forked from Advanced_Python/advanced-python-homework-2023
Finis the first home task
https://sciprogcentre.github.io/green-courses/pages/advanced_python/2023/hw/01.html
This commit is contained in:
parent
7b8168c829
commit
fb30925dfe
29
README.md
29
README.md
@ -12,15 +12,24 @@ To set up a virtual environment for your project and install dependencies, follo
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
python3.11 -m venv <venv>
|
python3.11 -m venv <venv>
|
||||||
|
```
|
||||||
|
|
||||||
3. ** Activate the Virtual Environment:On Windows:**
|
3. ** Activate the Virtual Environment:On Windows:**
|
||||||
On Windows: .\<venv>\Scripts\activate
|
On Windows:
|
||||||
On macOS and Linux: source <venv>/bin/activate
|
```bash
|
||||||
|
.\<venv>\Scripts\activate
|
||||||
|
```
|
||||||
|
On macOS and Linux:
|
||||||
|
```bash
|
||||||
|
source <venv>/bin/activate
|
||||||
|
```
|
||||||
Your command prompt should now show the virtual environment name, indicating that it's active.
|
Your command prompt should now show the virtual environment name, indicating that it's active.
|
||||||
|
|
||||||
4. ** Install Dependencies: **
|
4. ** Install Dependencies: **
|
||||||
Use pip to install the project's dependencies from the requirements.txt file. Replace <path_to_requirements.txt> with the actual path to your requirements.txt file:
|
Use pip to install the project's dependencies from the requirements.txt file. Replace <path_to_requirements.txt> with the actual path to your requirements.txt file:
|
||||||
pip install -r <path_to_requirements.txt>
|
```bash
|
||||||
|
pip install -r <path_to_requirements.txt>
|
||||||
|
```
|
||||||
This will install all the necessary packages for your project.
|
This will install all the necessary packages for your project.
|
||||||
|
|
||||||
5. ** Deactivate the Virtual Environment: **
|
5. ** Deactivate the Virtual Environment: **
|
||||||
@ -31,9 +40,15 @@ Now you have a virtual environment set up for your project with all the required
|
|||||||
## Creating Documentation
|
## Creating Documentation
|
||||||
|
|
||||||
1. ** Open 'Controls' directory **
|
1. ** Open 'Controls' directory **
|
||||||
On Linux: $ cd ./memorizer/controls
|
On Linux:
|
||||||
|
```bash
|
||||||
|
cd ./memorizer/controls
|
||||||
|
```
|
||||||
|
|
||||||
2. ** Open 'Controls' directory **
|
2. ** Run the next command **
|
||||||
On Linux: $ sphinx-quickstart
|
On Linux:
|
||||||
|
```bash
|
||||||
|
$ sphinx-quickstart
|
||||||
|
```
|
||||||
|
|
||||||
3. Follow the instructions
|
3. Follow the instructions of sphinx
|
Loading…
Reference in New Issue
Block a user