Skip to content

Commit 4052708

Browse files
allnesallnes
committed
Merge branch 'master' of https://github.com/learning-process/parallel_programming_course into an/increase-coverage
2 parents f54b2f0 + 76d2e34 commit 4052708

File tree

20 files changed

+806
-504
lines changed

20 files changed

+806
-504
lines changed

‎.github/workflows/pages.yml

+8-9
Original file line numberDiff line numberDiff line change
@@ -21,24 +21,23 @@ jobs:
2121
with:
2222
python-version: '3.13'
2323
- name: Install dependencies
24-
working-directory: ./docs
2524
run: |
26-
python3 -m pip install -r requirements.txt
25+
python3 -m pip install -r docs/requirements.txt
26+
- name: Configure project
27+
run: >
28+
cmake -S . -B build -D USE_DOCS=ON
2729
- name: Build i18n
28-
working-directory: ./docs
2930
run: |
30-
make gettext
31-
sphinx-build -b gettext . _build/gettext
32-
sphinx-intl update -p _build/gettext -l en -l ru
31+
cmake --build build -t docs_gettext
32+
cmake --build build -t docs_update
3333
- name: Build documentation
34-
working-directory: ./docs
3534
run: |
36-
make html
35+
cmake --build build -t docs_html
3736
- name: Upload artifact
3837
uses: actions/upload-artifact@v4
3938
with:
4039
name: sphinx-documentation
41-
path: ./docs/_build/html
40+
path: ./build/docs/_build/html
4241
build-scoreboard:
4342
runs-on: ubuntu-24.04
4443
steps:

‎CMakeLists.txt

+6
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,12 @@ message( STATUS "PPC step: Setup external projects" )
2424
include(cmake/opencv.cmake)
2525
include(cmake/gtest.cmake)
2626

27+
########################### Documentation ###########################
28+
29+
message( STATUS "PPC step: Setup documentation generation" )
30+
include(cmake/sphinx.cmake)
31+
add_subdirectory(docs)
32+
2733
############################ Scoreboard #############################
2834

2935
message( STATUS "PPC step: Setup scoreboard generator" )

‎cmake/sphinx.cmake

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
option(USE_DOCS OFF)
2+
if( USE_DOCS )
3+
set(SPHINXBUILD "sphinx-build")
4+
set(SPHINXINTL "sphinx-intl")
5+
set(SPHINXOPTS "-W" "--keep-going" "-n")
6+
endif( USE_DOCS )

‎docs/CMakeLists.txt

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
if (NOT USE_DOCS)
2+
return()
3+
endif()
4+
5+
set(SOURCEDIR "${CMAKE_CURRENT_SOURCE_DIR}")
6+
set(BUILDDIR "${CMAKE_CURRENT_BINARY_DIR}/_build/html")
7+
set(GETTEXTDIR "${CMAKE_CURRENT_BINARY_DIR}/_build/gettext")
8+
9+
add_custom_target(docs_help
10+
COMMAND ${SPHINXBUILD} -M help "${SOURCEDIR}" "${BUILDDIR}/en" ${SPHINXOPTS}
11+
WORKING_DIRECTORY "${SOURCEDIR}"
12+
COMMENT "Displaying Sphinx Makefile help"
13+
)
14+
15+
# 'gettext' target: generate gettext catalogs.
16+
add_custom_target(docs_gettext
17+
COMMAND ${SPHINXBUILD} -b gettext "${SOURCEDIR}" "${GETTEXTDIR}" ${SPHINXOPTS}
18+
WORKING_DIRECTORY "${SOURCEDIR}"
19+
COMMENT "Generating gettext output"
20+
)
21+
22+
# 'update' target: update translations for the specified languages.
23+
add_custom_target(docs_update
24+
COMMAND ${SPHINXINTL} update -p "${GETTEXTDIR}" -l en -l ru
25+
WORKING_DIRECTORY "${SOURCEDIR}"
26+
COMMENT "Updating Sphinx translations"
27+
)
28+
29+
# 'html' target: build the HTML documentation in both English and Russian.
30+
add_custom_target(docs_html
31+
# Build English documentation.
32+
COMMAND ${SPHINXBUILD} -b html -D language=en "${SOURCEDIR}" "${BUILDDIR}/en" ${SPHINXOPTS}
33+
# Build Russian documentation.
34+
COMMAND ${SPHINXBUILD} -b html -D language=ru "${SOURCEDIR}" "${BUILDDIR}/ru" ${SPHINXOPTS}
35+
WORKING_DIRECTORY "${SOURCEDIR}"
36+
COMMENT "Building HTML documentation for English and Russian"
37+
)

‎docs/Makefile

-29
This file was deleted.

‎docs/README.md

+14-9
Original file line numberDiff line numberDiff line change
@@ -17,30 +17,35 @@ python3 -m venv venv
1717
pip install -r requirements.txt
1818
```
1919

20-
4. Build the documentation:
20+
4. Configure the documentation build:
2121
```bash
22-
make html
22+
cmake -S . -B build -DUSE_DOCS=ON
2323
```
2424

25-
5. Update the documentation:
25+
5. Build the documentation:
2626
```bash
27-
make gettext
27+
cmake --build build -t docs_html
28+
```
29+
30+
6. Update the documentation:
31+
```bash
32+
cmake --build build -t docs_gettext
2833
# update documentation
29-
make update
34+
cmake --build build -t docs_update
3035
```
3136

32-
6. Re-build the documentation:
37+
7. Re-build the documentation:
3338
```bash
34-
make html
39+
cmake --build build -t docs_html
3540
```
3641

37-
7. Make local deployment of the changes:
42+
8. Make local deployment of the changes:
3843
```bash
3944
cd _build/html
4045
python3 -m http.server 8080
4146
```
4247

43-
8. Open the documentation in your browser:
48+
9. Open the documentation in your browser:
4449
```bash
4550
open http://localhost:8080/en
4651
open http://localhost:8080/ru

‎docs/common_information/introduction.rst

+4-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,10 @@ Practice
1717
- Additionally, each repository includes an example of a properly formatted PULL REQUEST.
1818
- Submission of all tasks is mandatory to pass the course.
1919
- A task that has been merged into the master branch continues to be monitored.
20-
If a task fails in the master, it is disabled, and a record of this is added to the score table. All disabled tasks will result in a zero points result for those tasks at the end of the semester.
20+
If a task fails in the master, it is disabled, and a record of this is added to the score table.
21+
All disabled tasks will result in a zero points result for those tasks at the end of the semester.
22+
It can be seen that your task is disabled due to the following reason: the directory of your task has been renamed
23+
from ``seq/nesterov_a_vector_sum`` to ``seq/nesterov_a_vector_sum_disabled``
2124
- All resources for using the repository will be provided here:
2225

2326
- `Git for half an hour: A Beginner’s Guide <https://proglib.io/p/git-for-half-an-hour>`__

‎docs/common_information/points.rst

+43-10
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ Points
55

66
- 1st MPI task
77

8-
======== ===========
9-
Solution Compilation
10-
======== ===========
11-
5 5
12-
======== ===========
8+
+----------+
9+
| Solution |
10+
+==========+
11+
| 10 |
12+
+----------+
1313

1414
- 2nd MPI task
1515

@@ -33,11 +33,11 @@ Points
3333

3434
- Sequential version
3535

36-
======== ===========
37-
Solution Compilation
38-
======== ===========
39-
2 2
40-
======== ===========
36+
+----------+
37+
| Solution |
38+
+==========+
39+
| 4 |
40+
+----------+
4141

4242
- OpenMP version
4343

@@ -74,6 +74,38 @@ Points
7474

7575
- **Total : 54 points**
7676

77+
- The rule for earning performance points.
78+
79+
The ratio of efficiency percentage to points percentage, where the maximum points is 100% and the minimum points is 0%.
80+
81+
If the score is not an integer, it is rounded up.
82+
83+
+----------------+-------------------+
84+
| Efficiency (%) | Points percentage |
85+
+================+===================+
86+
| >= 50% | 100% |
87+
+----------------+-------------------+
88+
| [45, 50) | 90% |
89+
+----------------+-------------------+
90+
| [42, 45) | 80% |
91+
+----------------+-------------------+
92+
| [40, 42) | 70% |
93+
+----------------+-------------------+
94+
| [37, 40) | 60% |
95+
+----------------+-------------------+
96+
| [35, 37) | 50% |
97+
+----------------+-------------------+
98+
| [32, 35) | 40% |
99+
+----------------+-------------------+
100+
| [30, 32) | 30% |
101+
+----------------+-------------------+
102+
| [27, 30) | 20% |
103+
+----------------+-------------------+
104+
| [25, 27) | 10% |
105+
+----------------+-------------------+
106+
| < 25% | 0% |
107+
+----------------+-------------------+
108+
77109
- Report
78110

79111
+--------------+--------------+--------------------+-------+
@@ -118,3 +150,4 @@ Points
118150
- Comments:
119151

120152
- It is forbidden to write the report if all tasks are not completed.
153+
- Please keep in mind that one week before the end of the semester, the repository will be closed for final assessment.

‎docs/common_information/report.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Report
1111

1212
- Requirements for Criteria
1313

14-
- Presence and Completeness
14+
- Completeness
1515

1616
- Introduction (can be a short paragraph)
1717
- Problem Statement (descriptive)

‎docs/locale/en/LC_MESSAGES/common_information/introduction.po

+22-20
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ msgid ""
99
msgstr ""
1010
"Project-Id-Version: Parallel Programming Course \n"
1111
"Report-Msgid-Bugs-To: \n"
12-
"POT-Creation-Date: 2025-02-05 13:29+0100\n"
12+
"POT-Creation-Date: 2025-02-09 00:23+0100\n"
1313
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
1414
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
1515
"Language: en\n"
@@ -79,104 +79,106 @@ msgid ""
7979
"A task that has been merged into the master branch continues to be "
8080
"monitored. If a task fails in the master, it is disabled, and a record of"
8181
" this is added to the score table. All disabled tasks will result in a "
82-
"zero points result for those tasks at the end of the semester."
82+
"zero points result for those tasks at the end of the semester. It can be "
83+
"seen that your task is disabled due to the following reason: the "
84+
"directory of your task has been renamed from "
85+
"``seq/nesterov_a_vector_sum`` to ``seq/nesterov_a_vector_sum_disabled``"
8386
msgstr ""
8487

85-
#: ../../common_information/introduction.rst:21
88+
#: ../../common_information/introduction.rst:24
8689
msgid "All resources for using the repository will be provided here:"
8790
msgstr ""
8891

89-
#: ../../common_information/introduction.rst:23
92+
#: ../../common_information/introduction.rst:26
9093
msgid ""
9194
"`Git for half an hour: A Beginner’s Guide <https://proglib.io/p/git-for-"
9295
"half-an-hour>`__"
9396
msgstr ""
9497

95-
#: ../../common_information/introduction.rst:24
98+
#: ../../common_information/introduction.rst:27
9699
#, python-format
97100
msgid ""
98101
"`Getting Started with Git and GitHub: A Beginner’s Guide "
99102
"<https://medium.com/nuances-of-"
100103
"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>`__"
101104
msgstr ""
102105

103-
#: ../../common_information/introduction.rst:25
106+
#: ../../common_information/introduction.rst:28
104107
msgid ""
105108
"`Git: A Quick Start Guide to Using Core Operations with Explanations "
106109
"<https://tproger.ru/translations/git-quick-start/>`__"
107110
msgstr ""
108111

109-
#: ../../common_information/introduction.rst:26
112+
#: ../../common_information/introduction.rst:29
110113
msgid ""
111114
"`Conflicts resolving in Git "
112115
"<https://githowto.com/ru/resolving_conflicts>`__"
113116
msgstr ""
114117

115-
#: ../../common_information/introduction.rst:27
118+
#: ../../common_information/introduction.rst:30
116119
msgid "`Google testing framework (gtest) <https://habr.com/ru/post/119090/>`__"
117120
msgstr ""
118121

119-
#: ../../common_information/introduction.rst:28
122+
#: ../../common_information/introduction.rst:31
120123
msgid ""
121124
"`GoogleTest Primer "
122125
"<https://github.com/google/googletest/blob/main/docs/primer.md>`__"
123126
msgstr ""
124127

125-
#: ../../common_information/introduction.rst:29
128+
#: ../../common_information/introduction.rst:32
126129
msgid "`GitHub Actions documentation <https://docs.github.com/ru/actions>`__"
127130
msgstr ""
128131

129-
#: ../../common_information/introduction.rst:30
132+
#: ../../common_information/introduction.rst:33
130133
msgid ""
131134
"`Parallel Programming Technologies. Message Passing Interface (MPI) "
132135
"<https://parallel.ru/vvv/mpi.html#p1>`__"
133136
msgstr ""
134137

135-
#: ../../common_information/introduction.rst:31
138+
#: ../../common_information/introduction.rst:34
136139
msgid ""
137140
"`Typing and Layout in the System LaTeX <https://www.mccme.ru/free-"
138141
"books/llang/newllang.pdf>`__"
139142
msgstr ""
140143

141-
#: ../../common_information/introduction.rst:32
144+
#: ../../common_information/introduction.rst:35
142145
msgid ""
143146
"`LaTeX for the beginners "
144147
"<https://web.archive.org/web/20210420184700/http://www.docs.is.ed.ac.uk/skills/documents/3722/3722-2014.pdf>`__"
145148
msgstr ""
146149

147-
#: ../../common_information/introduction.rst:33
150+
#: ../../common_information/introduction.rst:36
148151
msgid "`What is OpenMP? <https://parallel.ru/tech/tech_dev/openmp.html>`__"
149152
msgstr ""
150153

151-
#: ../../common_information/introduction.rst:34
154+
#: ../../common_information/introduction.rst:37
152155
msgid ""
153156
"`TBB-1 "
154157
"<https://web.archive.org/web/20220406024622/http://www.unn.ru/pages/e-library/aids/2007/12.pdf>`__"
155158
msgstr ""
156159

157-
#: ../../common_information/introduction.rst:35
160+
#: ../../common_information/introduction.rst:38
158161
msgid ""
159162
"`Writing Multithreaded Applications in C++ <https://eax.me/cpp-"
160163
"multithreading/>`__"
161164
msgstr ""
162165

163-
#: ../../common_information/introduction.rst:36
166+
#: ../../common_information/introduction.rst:39
164167
msgid ""
165168
"`Multithreading: New Features of the C++11 Standard "
166169
"<https://web.archive.org/web/20200608173050/http://www.quizful.net/post"
167170
"/multithreading-cpp11>`__"
168171
msgstr ""
169172

170-
#: ../../common_information/introduction.rst:37
173+
#: ../../common_information/introduction.rst:40
171174
msgid ""
172175
"`Introduction to Parallel Computing "
173176
"<http://ikt.muctr.ru/images/info/2Lecture_3.pdf>`__"
174177
msgstr ""
175178

176-
#: ../../common_information/introduction.rst:39
179+
#: ../../common_information/introduction.rst:42
177180
msgid ""
178181
"\\* *All instructions, repositories, and tables may be updated during the"
179182
" learning process for better usability. Be prepared for changes, check "
180183
"and update them periodically!!!*"
181184
msgstr ""
182-

0 commit comments

Comments
 (0)