Parallel Programming Course Documentation

How to make and test your changes

1. Navigate to the project root directory:

cd parallel_programming_course

2. (Optional) Create a virtual environment:

python3 -m venv venv

3. Install the required dependencies (for the projects and the docs):

pip install -r requirements.txt
pip install -r docs/requirements.txt

4. Configure the documentation build:

cmake -S . -B build -DUSE_DOCS=ON

5. Generate API documentation with Doxygen:

doxygen Doxyfile

6. Build the documentation:

cmake --build build -t docs_html

7. Update the documentation:

cmake --build build -t docs_gettext
# update documentation
cmake --build build -t docs_update

8. Re-build the documentation:

cmake --build build -t docs_html

9. Make local deployment of the changes:

cd docs/_build/html
python3 -m http.server 8080

10. Open the documentation in your browser. Depending on your platform use open (macOS), xdg-open (Linux), or start (Windows):

open http://localhost:8080/en     # macOS
xdg-open http://localhost:8080/en # Linux
start http://localhost:8080/en    # Windows

open http://localhost:8080/ru     # macOS
xdg-open http://localhost:8080/ru # Linux
start http://localhost:8080/ru    # Windows