Skip to content

Commit dd7f52a

Browse files
aobolenskaobolensk
authored
[Doc] Fill API sphinx docs page (#610)
1 parent ebd719f commit dd7f52a

File tree

4 files changed

+176
-2
lines changed

4 files changed

+176
-2
lines changed

‎docs/conf.py‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,12 @@
2424
}
2525
breathe_default_project = "ParallelProgrammingCourse"
2626

27+
# Suppress specific warnings for API documentation
28+
suppress_warnings = [
29+
"ref.ref", # undefined label warnings
30+
"ref.identifier", # cpp:identifier reference target not found
31+
]
32+
2733
templates_path = ["_templates"]
2834
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
2935
locale_dirs = ["locale"]

‎docs/locale/en/LC_MESSAGES/user_guide/api.po‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Parallel Programming Course Documentation.
2+
# Copyright (C) 2025, Learning Process
3+
# This file is distributed under the same license as the Parallel
4+
# Programming Course package.
5+
# Learning Process Team <nesterov.alexander@outlook.com>, 2025.
6+
#
7+
msgid ""
8+
msgstr ""
9+
"Project-Id-Version: Parallel Programming Course \n"
10+
"Report-Msgid-Bugs-To: \n"
11+
"POT-Creation-Date: 2025-08-22 21:38+0200\n"
12+
"PO-Revision-Date: 2025-08-22 21:45+0200\n"
13+
"Last-Translator: Learning Process Team <nesterov.alexander@outlook.com>\n"
14+
"Language: en\n"
15+
"Language-Team: Learning Process Team (gooddoog@student.su, nesterov.alexander@outlook.com)\n"
16+
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
17+
"MIME-Version: 1.0\n"
18+
"Content-Type: text/plain; charset=utf-8\n"
19+
"Content-Transfer-Encoding: 8bit\n"
20+
"Generated-By: Babel 2.17.0\n"
21+
22+
#: ../../../../docs/user_guide/api.rst:2
23+
msgid "API Reference"
24+
msgstr ""
25+
26+
#: ../../../../docs/user_guide/api.rst:8
27+
msgid "Runners Module"
28+
msgstr ""
29+
30+
#: ../../../../docs/user_guide/api.rst
31+
msgid "Functions"
32+
msgstr ""
33+
34+
#: ../../../../docs/user_guide/api.rst
35+
msgid "Parameters"
36+
msgstr ""
37+
38+
#: ../../../../docs/user_guide/api.rst
39+
msgid "Returns"
40+
msgstr ""
41+
42+
#: ../../../../docs/user_guide/api.rst:14
43+
msgid "Task Module"
44+
msgstr ""
45+
46+
#: ../../../../docs/user_guide/api.rst
47+
msgid "Typedefs"
48+
msgstr ""
49+
50+
#: ../../../../docs/user_guide/api.rst
51+
msgid "Template Parameters"
52+
msgstr ""
53+
54+
#: ../../../../docs/user_guide/api.rst
55+
msgid "Enums"
56+
msgstr ""
57+
58+
#: ../../../../docs/user_guide/api.rst
59+
msgid "Throws"
60+
msgstr ""
61+
62+
#: ../../../../docs/user_guide/api.rst
63+
msgid "Variables"
64+
msgstr ""
65+
66+
#: ../../../../docs/user_guide/api.rst:20
67+
msgid "Utility Module"
68+
msgstr ""
69+
70+
#: ../../../../docs/user_guide/api.rst:26
71+
msgid "Performance Module"
72+
msgstr ""
73+

‎docs/locale/ru/LC_MESSAGES/user_guide/api.po‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Parallel Programming Course Documentation.
2+
# Copyright (C) 2025, Learning Process
3+
# This file is distributed under the same license as the Parallel
4+
# Programming Course package.
5+
# Learning Process Team <gooddoog@student.su>, 2025.
6+
#
7+
msgid ""
8+
msgstr ""
9+
"Project-Id-Version: Parallel Programming Course \n"
10+
"Report-Msgid-Bugs-To: \n"
11+
"POT-Creation-Date: 2025-08-22 21:38+0200\n"
12+
"PO-Revision-Date: 2025-08-22 21:45+0200\n"
13+
"Last-Translator: Learning Process Team <gooddoog@student.su>\n"
14+
"Language: ru\n"
15+
"Language-Team: Learning Process Team (gooddoog@student.su, nesterov.alexander@outlook.com)\n"
16+
"Plural-Forms: nplurals=3; plural=(n%10==1 && n%100!=11 ? 0 : n%10>=2 && "
17+
"n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2);\n"
18+
"MIME-Version: 1.0\n"
19+
"Content-Type: text/plain; charset=utf-8\n"
20+
"Content-Transfer-Encoding: 8bit\n"
21+
"Generated-By: Babel 2.17.0\n"
22+
23+
#: ../../../../docs/user_guide/api.rst:2
24+
msgid "API Reference"
25+
msgstr "Справочник API"
26+
27+
#: ../../../../docs/user_guide/api.rst:8
28+
msgid "Runners Module"
29+
msgstr "Модуль выполнения"
30+
31+
#: ../../../../docs/user_guide/api.rst
32+
msgid "Functions"
33+
msgstr "Функции"
34+
35+
#: ../../../../docs/user_guide/api.rst
36+
msgid "Parameters"
37+
msgstr "Параметры"
38+
39+
#: ../../../../docs/user_guide/api.rst
40+
msgid "Returns"
41+
msgstr "Возвращаемые значения"
42+
43+
#: ../../../../docs/user_guide/api.rst:14
44+
msgid "Task Module"
45+
msgstr "Модуль задач"
46+
47+
#: ../../../../docs/user_guide/api.rst
48+
msgid "Typedefs"
49+
msgstr "Псевдонимы типов"
50+
51+
#: ../../../../docs/user_guide/api.rst
52+
msgid "Template Parameters"
53+
msgstr "Параметры шаблона"
54+
55+
#: ../../../../docs/user_guide/api.rst
56+
msgid "Enums"
57+
msgstr "Перечисления"
58+
59+
#: ../../../../docs/user_guide/api.rst
60+
msgid "Throws"
61+
msgstr "Исключения"
62+
63+
#: ../../../../docs/user_guide/api.rst
64+
msgid "Variables"
65+
msgstr "Переменные"
66+
67+
#: ../../../../docs/user_guide/api.rst:20
68+
msgid "Utility Module"
69+
msgstr "Вспомогательный модуль (модуль с утилитами)"
70+
71+
#: ../../../../docs/user_guide/api.rst:26
72+
msgid "Performance Module"
73+
msgstr "Модуль измерения производительности"
74+

‎docs/user_guide/api.rst‎

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,26 @@ API Reference
44
.. toctree::
55
:maxdepth: 1
66

7-
.. .. doxygenindex::
8-
.. :project: ParallelProgrammingCourse
7+
Runners Module
8+
--------------
9+
10+
.. doxygennamespace:: ppc::runners
11+
:project: ParallelProgrammingCourse
12+
13+
Task Module
14+
-----------
15+
16+
.. doxygennamespace:: ppc::task
17+
:project: ParallelProgrammingCourse
18+
19+
Utility Module
20+
--------------
21+
22+
.. doxygennamespace:: ppc::util
23+
:project: ParallelProgrammingCourse
24+
25+
Performance Module
26+
------------------
27+
28+
.. doxygennamespace:: ppc::performance
29+
:project: ParallelProgrammingCourse

0 commit comments

Comments
 (0)