feat: check svg usage (!330) · Merge requests · core / docs

Artur Sabirov requested to merge check-svg-usage into main Feb 22, 2024

Описание

Добавлен хук check_unused_svg.py, который проверяет, все ли файлы .svg из папки docs/images используются в документации — то есть принадлежат множеству used_svg.

Множество used_svg формата set[str] содержит относительные пути файлов .svg, используемых в документации. Множество генерируется в хуке check_svg_attrs.py и добавляется в конфигурационный файл MkDocs.

Если файл .svg не используется в документации, в лог MkDocs будет выведена следующая запись со статусом INFO:

INFO    -  check_unused_svg: UNUSED SVG: images/table_joined.svg

See:

!273 (merged) — прецедент
!315 (merged) — источник хука check_svg_attrs.py

~~Close #...~~
Target branch: main
Changes should be cherry-picked to 24.1: NO
Staging: https://docs.binary.picodata.io/picodata/branch-check-svg-usage/

Edited Feb 26, 2024 by Artur Sabirov

feat: check svg usage

Описание

Merge request reports