- Navigate to the project root directory:
cd parallel_programming_course- (Optional) Create a virtual environment:
python3 -m venv venv- Install the required dependencies (for the projects and the docs):
pip install -r requirements.txt
pip install -r docs/requirements.txt- Configure the documentation build:
cmake -S . -B build -DUSE_DOCS=ON -DPPC_BUILD_COMPONENTS=OFFNote: -DPPC_BUILD_COMPONENTS=OFF could be used to configure documentation without C++ project dependencies
- Generate API documentation with Doxygen:
doxygen Doxyfile- Build the documentation:
cmake --build build -t docs_html- Update the documentation:
cmake --build build -t docs_gettext
# update documentation
cmake --build build -t docs_update- Check that committed translations are up to date:
cmake --build build -t docs_i18n_check- Re-build the documentation:
cmake --build build -t docs_html- Make local deployment of the changes:
cd docs/_build/html
python3 -m http.server 8080- Open the documentation in your browser.
Depending on your platform use
open(macOS),xdg-open(Linux), orstart(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