[joinrpg-docs-253] fix by linter

Author: avs51

.github/workflows/dev-deploy.yml

@@ -29,7 +29,39 @@ jobs:
       - name: Build static files
         run: |
           cd docs
-          make html-all
+          make html-all 2>&1 | tee build.log
+          
+          # Parse warnings and errors and create GitHub annotations
+          if grep -E "(WARNING|ERROR|CRITICAL)" build.log > /dev/null; then
+            echo "::group::Build Warnings and Errors"
+            while IFS= read -r line; do
+              # Match Sphinx warning/error format: file.rst:123: WARNING: message
+              if echo "$line" | grep -qE "\.(rst|md):[0-9]+: (WARNING|ERROR|CRITICAL)"; then
+                file=$(echo "$line" | sed -E 's|^([^:]+):[0-9]+:.*|\1|')
+                line_num=$(echo "$line" | sed -E 's|^[^:]+:([0-9]+):.*|\1|')
+                message=$(echo "$line" | sed -E 's|^[^:]+:[0-9]+: (WARNING|ERROR|CRITICAL): ||')
+                
+                # Make path relative to repo root (we're in docs/ directory)
+                if [[ "$file" != /* ]]; then
+                  # Already relative, ensure it's from repo root
+                  file="docs/$file"
+                else
+                  # Absolute path, convert to relative
+                  file=$(realpath --relative-to="$GITHUB_WORKSPACE" "$file" 2>/dev/null || echo "$file")
+                fi
+                
+                if echo "$line" | grep -qE "ERROR|CRITICAL"; then
+                  echo "::error file=$file,line=$line_num::$message"
+                else
+                  echo "::warning file=$file,line=$line_num::$message"
+                fi
+              fi
+            done < build.log
+            echo "::endgroup::"
+          fi
+          
+          # Show summary
+          echo "::notice::Build completed. Check the log above for details."
 
       - name: Upload build artifact
         uses: actions/upload-artifact@v5.0.0

.github/workflows/prod-deploy.yml

@@ -27,7 +27,39 @@ jobs:
       - name: Build static files
         run: |
           cd docs
-          make html-all
+          make html-all 2>&1 | tee build.log
+          
+          # Parse warnings and errors and create GitHub annotations
+          if grep -E "(WARNING|ERROR|CRITICAL)" build.log > /dev/null; then
+            echo "::group::Build Warnings and Errors"
+            while IFS= read -r line; do
+              # Match Sphinx warning/error format: file.rst:123: WARNING: message
+              if echo "$line" | grep -qE "\.(rst|md):[0-9]+: (WARNING|ERROR|CRITICAL)"; then
+                file=$(echo "$line" | sed -E 's|^([^:]+):[0-9]+:.*|\1|')
+                line_num=$(echo "$line" | sed -E 's|^[^:]+:([0-9]+):.*|\1|')
+                message=$(echo "$line" | sed -E 's|^[^:]+:[0-9]+: (WARNING|ERROR|CRITICAL): ||')
+                
+                # Make path relative to repo root (we're in docs/ directory)
+                if [[ "$file" != /* ]]; then
+                  # Already relative, ensure it's from repo root
+                  file="docs/$file"
+                else
+                  # Absolute path, convert to relative
+                  file=$(realpath --relative-to="$GITHUB_WORKSPACE" "$file" 2>/dev/null || echo "$file")
+                fi
+                
+                if echo "$line" | grep -qE "ERROR|CRITICAL"; then
+                  echo "::error file=$file,line=$line_num::$message"
+                else
+                  echo "::warning file=$file,line=$line_num::$message"
+                fi
+              fi
+            done < build.log
+            echo "::endgroup::"
+          fi
+          
+          # Show summary
+          echo "::notice::Build completed. Check the log above for details."
 
       - name: Upload build artifact
         uses: actions/upload-artifact@v5.0.0

docs/accommodation/rooms_for_participants.rst

@@ -1,5 +1,5 @@
 Расселение участников
-=======================
+=====================
 
 Для того, чтобы определить проживание участников в конкретных комнатах с конкретными соседями, воспользуйтесь меню **Прочее > Настройки > Поселение > (иконка «расселение» у нужного типа комнаты)**
 
@@ -20,7 +20,7 @@
 .. attention:: Список соседей со ссылкой на профиль joinrpg будет виден всем проживающим в этой комнате. Избегайте спойлеров для игроков!
 
 Список участников для типа размещения
----------------------------------
+-------------------------------------
 
 На вкладке «Комнаты» типа размещения показываются все участники, в заявках которых указан этот тип. Сверху располагаются те, кто еще не приписан к конкретной комнате; те, чье проживание определено, расположены в ячейках соответствующих помещений. Каждая заявка сопровождается указанием, сколько из назначенной к оплате суммы (включая оргвзнос, цену за место проживания, другие выбранные опции) еще осталось оплатить.
 
@@ -31,7 +31,7 @@
 
 
 Массовое заселение / выселение
----------------------------------
+------------------------------
 
 .. figure:: in_or_out.JPG
        :scale: 100 %
@@ -46,7 +46,7 @@
 Функция «Выселить всех» также доступна на странице со списком типов размещения. При ее использовании будут освобождены все комнаты всех типов разменения
 
 Выбор проживающих для каждой комнаты
---------------------------------------
+------------------------------------
 
 .. figure:: in_for_room.JPG
        :scale: 100 %

docs/api/integration.rst

@@ -1,11 +1,11 @@
 Интеграция ИТ систем
-========================
+====================
 
 Данный документ призван обобщить опыт игр Deus Ex и Магеллан по тому, как удобно и правильно  интегрировать бекенд вашей игры и joinrpg.
 Предназначен для мастеров, у которых на игре есть некая ИТ-система, предоставляющая возможности в рамках игрового мира. В дальнейшем будем называть ее Система.
 
 Привязка всего к персонажу
------------------------
+--------------------------
 .. note:: Эти принципы мы считаем разумными для всех интеграций
 
 Источником правды о персонажах на начало игры является данные из joinrpg. Это даст мастерам возможность вести всю информацию по игре в одном месте, использовать удобные и привычные инструменты для управления.
@@ -17,7 +17,7 @@
 3. На игре менять роль игроку (выпуск второй ролью).
 
 Поля персонажа
------
+--------------
 Для хранения всех данных по персонажу надо использовать поля персонажа. В API это называется ``CharacterFields``.
 
 Обратите внимание, что дополнительные данные по полям (например, метаданные по вариантам выпадаек) можно хранить в поле ``ProgrammaticalValue`` и загрузить при помощи `MetaDataApi_GetFieldsList <https://joinrpg.ru/swagger/index.html#/MetaDataApi/get_x_game_api__projectId__metadata_fields>`_. 
@@ -34,7 +34,7 @@
 Пароль в вашу систему рекомендуем хранить в поле персонажа типа PIN-код. Он будет создан автоматически (но при желании вы сможете вручную его отредактировать).
 
 «В игре»
--------
+--------
 
 У персонажа есть флаг «В игре» — ``InGame``:
 
@@ -44,14 +44,14 @@
 
 
 Использование joinrpg в качестве бекенда
-------------
+----------------------------------------
 
 Не рекомендуется использовать joinrpg в качестве непосредственного бекенда для вашего приложения. Мы не гарантируем соблюдения ваших требований по нагрузке и надежности. Правильный вариант, чтобы бекендом для вашего приложения был ваш сервис с вашей базой, который работает независимо от joinrpg.
 
 Впрочем, если вы всегда запрашиваете данные `по одному персонажу по его Id <https://joinrpg.ru/swagger/index.html#/CharacterApi/get_x_game_api__projectId__characters__characterId_>`_, количество запросов не превышает сотен в час и вы готовы обеспечить стабильный канал до joinrpg, то это можно использовать как основной вариант. Преимущества: нет проблемы синхронизации.
 
 Заливка Excel
---------------
+-------------
 
 .. note:: Подходит только для простых ИТ-систем и маленьких игр.
 
@@ -68,7 +68,7 @@
 - не подходит, если игра большая (формирование Excel займет определенное время).
 
 Онлайн-импорт
------------------
+-------------
 
 .. note:: Мы рекомендуем этот вариант для сложных ИТ-систем
 

docs/characters/slots.rst

@@ -1,7 +1,7 @@
 .. _character-slot-label:
 
 Шаблоны персонажей
-============
+==================
 
 Шаблон персонажей - мастерский инструмент позволяющий создать одного персонажа (собственно, шаблон) на основании которого, при принятии заявки, будут созданы отдельные персонажи. Шаблону персонажей можно присваивать поля (в том числе и с предустановленным значением) и привязывать группы.
 

docs/checkin/during.rst

@@ -1,5 +1,5 @@
 Включение регистрации на полигоне
-========================
+=================================
 
 Чтобы начать регистрацию приезжающих на игру, пройдите в своем проекте: 
 **Прочее > Настройки > Настройки регистрации**

docs/checkin/statistic.rst

@@ -1,5 +1,5 @@
 Статистика зарегистрированных
-========================
+=============================
 
 Статистика по ходу регистрации доступна по ссылке **Прочее > Регистрация > Статистика по регистрации**.
 Показывается число принятых заявок, еще не прошедших регистрацию.

docs/communication/claim_comments.rst

@@ -1,5 +1,5 @@
 Комментарии в заявке
-========================
+====================
 
 Для комментариев в заявке используется древовидная система: все сообщения расположены иерархично, в зависимости от того, на какой конкретно комментарий был дан ответ. 
 
@@ -10,7 +10,7 @@
 Игроку приходят уведомления о любых видимых ему комментариях на e-mail. Ответственному за заявку мастеру приходят любые комментарии (как от игрока, так и от других мастеров). Остальные мастера `могут подписаться на уведомления о новых комментариях </communication/subscriptions.html>`_; также уведомления приходят тому мастеру, на комментарий которого вы отвечаете, вне зависимости от его личных настроек уведомлений.
 
 Автоматические комментарии
----------------------------------
+--------------------------
 
 Большинство значимых операций с заявкой (изменение статуса заявки, информация об отправке игроком и приеме мастером взноса) сопровождается комментарием, который остается в заявке. Такие комментарии имеют выделенный жирным заголовок — название операции, которая была произведена. Старайтесь оставлять значимые комментарии, которые помогут вам в будущем или другому мастеру понять, почему было то или иное решение (например, причины, по которым заявка была отклонена — даже если вы отклоняете «по просьбе игрока»).
 
@@ -31,7 +31,7 @@
 Для информирования мастеров о сдаче взноса пользуйтесь `специальной функцией </for_players/inform_about_payment.html>`_, а не обычными комментариями.
 
 Скрытые комментарии, видимые мастерам
-------------------------
+-------------------------------------
 
 Скрытые комментарии видны только другим мастерам (людям, у которых есть доступ в проект). Уведомления о скрытых комментариях приходят только тем мастерам, которые подписаны на комментарии к этой заявке или на чей комментарий оставляется ответ. Чтобы оставить скрытый комментарий, перед отправкой отметьте чекбокс «только для мастеров».
 
@@ -48,7 +48,7 @@
        :alt: Комментарий мастерам
 
 Как скрыть ошибочно оставленный комментарий
----------------------------------------------
+-------------------------------------------
 
 Комментарий, который был по ошибке оставлен игроку, но предназначался для мастеров, можно на странице заявки скрыть:
 

docs/communication/forums.rst

@@ -1,5 +1,5 @@
 Форумы
-========================
+======
 
 Форумы полезны для подготовки групп игроков, которые заявляются отдельно, но должны обсудить какие-то общие завязки. Как и комментарии в заявке, каждый форум имеет древовидную структуру с иерархией сообщений.
 
@@ -16,7 +16,7 @@
 .. attention:: Доступ к уже открытому форуму нельзя отредактировать, т.е. нельзя переназначить форум другой группе или скрыть его от всех кроме мастеров.
 
 Общие настройки нового форума
----------------------------------
+-----------------------------
 
 Каждый новый форум имеет заголовок и стартовое сообщение. И то, и другое видно всем, у кого есть доступ к этому форуму. Чтобы легче ориентироваться в списке форумов, советуем давать им значимые названия для облегчения навигации. Если вы хотите, чтобы всем участникам пришло уведомление об открытии нового форума — выберите пункт «уведомить по e-mail».
 
@@ -30,7 +30,7 @@
 .. hint:: Если форум предназначен для конкретной группы — удобно обозначить это в названии («Королевство Аэдирн: обсуждение завязок», «Хакеры: обсуждение внутренних правил», «Цинтра: строяк крепости» и т.п.), так как на странице со всеми форумами группа не показывается.
 
 Как завести новый форум для всех игроков
-------------------------------------
+----------------------------------------
 
 Доступные всем игрокам форумы можно заводить через меню группы «Все роли» или на странице всех форумов.
 
@@ -49,7 +49,7 @@
        :alt: Новый форум для всех через Все роли
 
 Как завести новый форум для группы
-------------------------------------	   
+----------------------------------
 
 Форумы можно заводить для любой `группы </groups/index.html>`_ или `специальной группы </groups/hidden-group.html#id5>`_). Вкладка «Форумы» доступна в общих настройках группы (перейдите к ним кликом по названию группы).
 
@@ -76,7 +76,7 @@
        :alt: Новый форум для Мастеров
 
 Примеры, как форумы выглядят для игроков
---------------------------------------------
+----------------------------------------
 
 Форумы, к которым у игрока есть доступ, показываются ему на странице всех активных форумов. К ней можно перейти через меню **Форумы > Все активные**.
 

docs/communication/index.rst

@@ -1,5 +1,5 @@
 Общение и уведомления 
-============
+=====================
 
 Мы стремимся к тому, чтобы максимум общения, связанного с подготовкой к игре, проходило через базу заявок. Общение игрока с мастером (или мастерами) происходит в его заявке, а для общения игроков друг с другом созданы форумы, привязанные к группам сетки ролей (можно создавать их для «всех игроков в Лондоне», «всех эльфов» и т.п. — любой `группы </groups/index.html>`_ или `специальной группы </groups/hidden-group.html#id5>`_).