Skip to content

Commit 7872904

Browse files
authored
Add README for docs (#255)
1 parent 676281b commit 7872904

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

docs/README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Parallel Programming Course Documentation
2+
3+
### How to make and test your changes
4+
5+
1. Navigate to the documentation directory:
6+
```bash
7+
cd parallel_programming_course/docs
8+
```
9+
10+
2. (Optional) Create a virtual environment:
11+
```bash
12+
python3 -m venv venv
13+
```
14+
15+
3. Install the required dependencies:
16+
```bash
17+
pip install -r requirements.txt
18+
```
19+
20+
4. Build the documentation:
21+
```bash
22+
make html
23+
```
24+
25+
5. Update the locale files:
26+
```bash
27+
make update
28+
```
29+
30+
6. Re-build the documentation:
31+
```bash
32+
make html
33+
```
34+
35+
7. Make local deployment of the changes:
36+
```bash
37+
cd _build/html
38+
python3 -m http.server 8080
39+
```
40+
41+
8. Open the documentation in your browser:
42+
```bash
43+
open http://localhost:8080/en
44+
open http://localhost:8080/ru
45+
```

0 commit comments

Comments
 (0)