Skip to content

Latest commit

 

History

History
57 lines (46 loc) · 997 Bytes

File metadata and controls

57 lines (46 loc) · 997 Bytes

Parallel Programming Course Documentation

How to make and test your changes

  1. Navigate to the documentation directory:
cd parallel_programming_course/docs
  1. (Optional) Create a virtual environment:
python3 -m venv venv
  1. Install the required dependencies:
pip install -r requirements.txt
  1. Configure the documentation build:
cmake -S . -B build -DUSE_DOCS=ON
  1. Generate API documentation with Doxygen:
doxygen Doxyfile
  1. Build the documentation:
cmake --build build -t docs_html
  1. Update the documentation:
cmake --build build -t docs_gettext
# update documentation
cmake --build build -t docs_update
  1. Re-build the documentation:
cmake --build build -t docs_html
  1. Make local deployment of the changes:
cd _build/html
python3 -m http.server 8080
  1. Open the documentation in your browser:
open http://localhost:8080/en
open http://localhost:8080/ru