Skip to content

Commit 0399068

Browse files
authored
HOT FIX: Update docs (#658)
1 parent bd68b78 commit 0399068

File tree

32 files changed

+3531
-1616
lines changed

32 files changed

+3531
-1616
lines changed

.github/workflows/pages.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,18 +37,22 @@ jobs:
3737
uses: actions/setup-python@v6
3838
with:
3939
python-version: '3.13'
40-
- name: Install Doxygen
40+
- name: Install Doxygen and Graphviz
4141
run: |
4242
sudo apt-get update
43-
sudo apt-get install --no-install-recommends -y doxygen
43+
sudo apt-get install --no-install-recommends -y doxygen graphviz
4444
- name: Install dependencies
4545
run: |
4646
python3 -m pip install -r docs/requirements.txt
47+
python3 -m pip install graphviz pyyaml
4748
- name: Download artifact
4849
uses: actions/download-artifact@v6
4950
with:
5051
name: doxygen-documentation-xml
5152
path: xml
53+
- name: Generate CI jobs graph
54+
run: |
55+
python3 scripts/jobs_graph.py --out docs/_static/ci_graph --format svg
5256
- name: Configure project
5357
run: >
5458
cmake -S . -B build -D USE_DOCS=ON

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ Coverage report is available [here](https://learning-process.github.io/parallel_
2121
* `oneAPI Threading Building Blocks (oneTBB)`
2222
* `Multithreading in C++ (std::thread)`
2323

24+
## Quickstart
25+
26+
See the full user guide for build, tests, docs, and tooling instructions: [documentation en](https://learning-process.github.io/parallel_programming_course/en/), [documentation ru](https://learning-process.github.io/parallel_programming_course/ru/).
27+
2428
### Rules for submissions:
2529
1. You are not supposed to trigger CI jobs by frequent updates of your pull request. First you should test you work locally with all the scripts (code style).
2630
* Respect others time and don't slow down the job queue

docs/_static/ci_graph.svg

Lines changed: 54 additions & 75 deletions
Loading

docs/common_information/introduction.rst

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,31 +12,25 @@ Practice
1212
- Test verification
1313

1414
- Task distribution is random for each student.
15-
- An example for each technology can be found in the corresponding directory: ``tasks/<all/omp/tbb/seq/stl/mpi>/example``.
16-
- In each repository, the README.md contains a link to the course documentation (**read it fully!!!**).
17-
- Additionally, each repository includes an example of a properly formatted PULL REQUEST.
15+
- Full automation of quality and performance checks; plagiarism checks are applied.
16+
- Deadlines are set per task. See the penalties and grading rules in ``Points``.
17+
- Examples are provided in ``tasks/example_threads`` and ``tasks/example_processes`` (and extended variations ``tasks/example_processes_2`` / ``tasks/example_processes_3``).
18+
- In each repository, the README.md contains a link to the course documentation.
19+
- Each repository includes an example of a properly formatted PULL REQUEST.
1820
- Submission of all tasks is mandatory to pass the course.
1921
- A task that has been merged into the master branch continues to be monitored.
2022
If a task fails in the master, it is disabled, and a record of this is added to the score table.
2123
All disabled tasks will result in a zero points result for those tasks at the end of the semester.
2224
It can be seen that your task is disabled due to the following reason: the directory of your task has been renamed
2325
from ``seq/nesterov_a_vector_sum`` to ``seq/nesterov_a_vector_sum_disabled``
24-
- All resources for using the repository will be provided here:
2526

26-
- `Git for half an hour: A Beginner’s Guide <https://proglib.io/p/git-for-half-an-hour>`__
27-
- `Getting Started with Git and GitHub: A Beginner’s Guide <https://medium.com/nuances-of-programming/%D0%B7%D0%BD%D0%B0%D0%BA%D0%BE%D0%BC%D1%81%D1%82%D0%B2%D0%BE-%D1%81-git-%D0%B8-github-%D1%80%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE-%D0%B4%D0%BB%D1%8F-%D0%BD%D0%B0%D1%87%D0%B8%D0%BD%D0%B0%D1%8E%D1%89%D0%B8%D1%85-54ea2567d76c>`__
28-
- `Git: A Quick Start Guide to Using Core Operations with Explanations <https://tproger.ru/translations/git-quick-start/>`__
29-
- `Conflicts resolving in Git <https://githowto.com/ru/resolving_conflicts>`__
30-
- `Google testing framework (gtest) <https://habr.com/ru/post/119090/>`__
31-
- `GoogleTest Primer <https://github.com/google/googletest/blob/main/docs/primer.md>`__
32-
- `GitHub Actions documentation <https://docs.github.com/ru/actions>`__
33-
- `Parallel Programming Technologies. Message Passing Interface (MPI) <https://parallel.ru/vvv/mpi.html#p1>`__
34-
- `Typing and Layout in the System LaTeX <https://www.mccme.ru/free-books/llang/newllang.pdf>`__
35-
- `LaTeX for the beginners <https://web.archive.org/web/20210420184700/http://www.docs.is.ed.ac.uk/skills/documents/3722/3722-2014.pdf>`__
36-
- `What is OpenMP? <https://parallel.ru/tech/tech_dev/openmp.html>`__
37-
- `TBB-1 <https://web.archive.org/web/20220406024622/http://www.unn.ru/pages/e-library/aids/2007/12.pdf>`__
38-
- `Writing Multithreaded Applications in C++ <https://eax.me/cpp-multithreading/>`__
39-
- `Multithreading: New Features of the C++11 Standard <https://web.archive.org/web/20200608173050/http://www.quizful.net/post/multithreading-cpp11>`__
40-
- `Introduction to Parallel Computing <http://ikt.muctr.ru/images/info/2Lecture_3.pdf>`__
27+
Communication
28+
~~~~~~~~~~~~~
4129

42-
\* *All instructions, repositories, and tables may be updated during the learning process for better usability. Be prepared for changes, check and update them periodically!!!*
30+
- Telegram channel — announcements and quick updates
31+
- GitHub Issues — repository problems and bug reports
32+
- Lessons — Q&A
33+
- Feedback form — critical issues
34+
- Email — non‑urgent matters
35+
36+
\* *All instructions, repositories, and tables may be updated during the learning process for better usability. Be prepared for changes and check updates periodically.*

0 commit comments

Comments
 (0)