From 2a3a5b7f972dddb765e4972afba2fa6ac1503e4a Mon Sep 17 00:00:00 2001 From: Arseniy Obolenskiy Date: Fri, 22 Aug 2025 19:10:08 +0200 Subject: [PATCH 1/3] [Doc] Fill API sphinx docs page --- docs/user_guide/api.rst | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/docs/user_guide/api.rst b/docs/user_guide/api.rst index e5b18d4f9..178c3f401 100644 --- a/docs/user_guide/api.rst +++ b/docs/user_guide/api.rst @@ -4,5 +4,26 @@ API Reference .. toctree:: :maxdepth: 1 -.. .. doxygenindex:: -.. :project: ParallelProgrammingCourse +Runners Module +-------------- + +.. doxygennamespace:: ppc::runners + :project: ParallelProgrammingCourse + +Task Module +----------- + +.. doxygennamespace:: ppc::task + :project: ParallelProgrammingCourse + +Utility Module +-------------- + +.. doxygennamespace:: ppc::util + :project: ParallelProgrammingCourse + +Performance Module +------------------ + +.. doxygennamespace:: ppc::performance + :project: ParallelProgrammingCourse From e3ed14dc9ca1fc7cac8ee882eb944d87d72e96e1 Mon Sep 17 00:00:00 2001 From: Arseniy Obolenskiy Date: Fri, 22 Aug 2025 21:49:05 +0200 Subject: [PATCH 2/3] translations --- docs/locale/en/LC_MESSAGES/user_guide/api.po | 73 +++++++++++++++++++ docs/locale/ru/LC_MESSAGES/user_guide/api.po | 74 ++++++++++++++++++++ 2 files changed, 147 insertions(+) create mode 100644 docs/locale/en/LC_MESSAGES/user_guide/api.po create mode 100644 docs/locale/ru/LC_MESSAGES/user_guide/api.po diff --git a/docs/locale/en/LC_MESSAGES/user_guide/api.po b/docs/locale/en/LC_MESSAGES/user_guide/api.po new file mode 100644 index 000000000..88a83db8a --- /dev/null +++ b/docs/locale/en/LC_MESSAGES/user_guide/api.po @@ -0,0 +1,73 @@ +# Parallel Programming Course Documentation. +# Copyright (C) 2025, Learning Process +# This file is distributed under the same license as the Parallel +# Programming Course package. +# Learning Process Team , 2025. +# +msgid "" +msgstr "" +"Project-Id-Version: Parallel Programming Course \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-22 21:38+0200\n" +"PO-Revision-Date: 2025-08-22 21:45+0200\n" +"Last-Translator: Learning Process Team \n" +"Language: en\n" +"Language-Team: Learning Process Team (gooddoog@student.su, nesterov.alexander@outlook.com)\n" +"Plural-Forms: nplurals=2; plural=(n != 1);\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.17.0\n" + +#: ../../../../docs/user_guide/api.rst:2 +msgid "API Reference" +msgstr "" + +#: ../../../../docs/user_guide/api.rst:8 +msgid "Runners Module" +msgstr "" + +#: ../../../../docs/user_guide/api.rst +msgid "Functions" +msgstr "" + +#: ../../../../docs/user_guide/api.rst +msgid "Parameters" +msgstr "" + +#: ../../../../docs/user_guide/api.rst +msgid "Returns" +msgstr "" + +#: ../../../../docs/user_guide/api.rst:14 +msgid "Task Module" +msgstr "" + +#: ../../../../docs/user_guide/api.rst +msgid "Typedefs" +msgstr "" + +#: ../../../../docs/user_guide/api.rst +msgid "Template Parameters" +msgstr "" + +#: ../../../../docs/user_guide/api.rst +msgid "Enums" +msgstr "" + +#: ../../../../docs/user_guide/api.rst +msgid "Throws" +msgstr "" + +#: ../../../../docs/user_guide/api.rst +msgid "Variables" +msgstr "" + +#: ../../../../docs/user_guide/api.rst:20 +msgid "Utility Module" +msgstr "" + +#: ../../../../docs/user_guide/api.rst:26 +msgid "Performance Module" +msgstr "" + diff --git a/docs/locale/ru/LC_MESSAGES/user_guide/api.po b/docs/locale/ru/LC_MESSAGES/user_guide/api.po new file mode 100644 index 000000000..7379ae505 --- /dev/null +++ b/docs/locale/ru/LC_MESSAGES/user_guide/api.po @@ -0,0 +1,74 @@ +# Parallel Programming Course Documentation. +# Copyright (C) 2025, Learning Process +# This file is distributed under the same license as the Parallel +# Programming Course package. +# Learning Process Team , 2025. +# +msgid "" +msgstr "" +"Project-Id-Version: Parallel Programming Course \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-22 21:38+0200\n" +"PO-Revision-Date: 2025-08-22 21:45+0200\n" +"Last-Translator: Learning Process Team \n" +"Language: ru\n" +"Language-Team: Learning Process Team (gooddoog@student.su, nesterov.alexander@outlook.com)\n" +"Plural-Forms: nplurals=3; plural=(n%10==1 && n%100!=11 ? 0 : n%10>=2 && " +"n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2);\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.17.0\n" + +#: ../../../../docs/user_guide/api.rst:2 +msgid "API Reference" +msgstr "Справочник API" + +#: ../../../../docs/user_guide/api.rst:8 +msgid "Runners Module" +msgstr "Модуль выполнения" + +#: ../../../../docs/user_guide/api.rst +msgid "Functions" +msgstr "Функции" + +#: ../../../../docs/user_guide/api.rst +msgid "Parameters" +msgstr "Параметры" + +#: ../../../../docs/user_guide/api.rst +msgid "Returns" +msgstr "Возвращаемые значения" + +#: ../../../../docs/user_guide/api.rst:14 +msgid "Task Module" +msgstr "Модуль задач" + +#: ../../../../docs/user_guide/api.rst +msgid "Typedefs" +msgstr "Псевдонимы типов" + +#: ../../../../docs/user_guide/api.rst +msgid "Template Parameters" +msgstr "Параметры шаблона" + +#: ../../../../docs/user_guide/api.rst +msgid "Enums" +msgstr "Перечисления" + +#: ../../../../docs/user_guide/api.rst +msgid "Throws" +msgstr "Исключения" + +#: ../../../../docs/user_guide/api.rst +msgid "Variables" +msgstr "Переменные" + +#: ../../../../docs/user_guide/api.rst:20 +msgid "Utility Module" +msgstr "Вспомогательный модуль (модуль с утилитами)" + +#: ../../../../docs/user_guide/api.rst:26 +msgid "Performance Module" +msgstr "Модуль измерения производительности" + From 6424cd4bf4827d74adaa4d0cada8f897ba99ceaa Mon Sep 17 00:00:00 2001 From: Arseniy Obolenskiy Date: Sat, 23 Aug 2025 13:38:34 +0200 Subject: [PATCH 3/3] conf.py --- docs/conf.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index a6f41a5f8..88353ff80 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -24,6 +24,12 @@ } breathe_default_project = "ParallelProgrammingCourse" +# Suppress specific warnings for API documentation +suppress_warnings = [ + "ref.ref", # undefined label warnings + "ref.identifier", # cpp:identifier reference target not found +] + templates_path = ["_templates"] exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] locale_dirs = ["locale"]