Skip to content

Refine docs/README.md #454

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
allnes merged 1 commit into from
Jun 20, 2025
Merged

Refine docs/README.md #454

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,20 @@

### How to make and test your changes

1. Navigate to the documentation directory:
1. Navigate to the project root directory:
```bash
cd parallel_programming_course/docs
cd parallel_programming_course
```

2. (Optional) Create a virtual environment:
```bash
python3 -m venv venv
```

3. Install the required dependencies:
3. Install the required dependencies (for the projects and the docs):
```bash
pip install -r requirements.txt
pip install -r docs/requirements.txt
```

4. Configure the documentation build:
Expand Down Expand Up @@ -46,7 +47,7 @@ cmake --build build -t docs_html

9. Make local deployment of the changes:
```bash
cd _build/html
cd docs/_build/html
python3 -m http.server 8080
```

Expand Down
Loading