feat: check sorting in reference/cli.md
Описание
Добавлен хук check_sorting.py
, который проверяет порядок следования подзаголовков --<option>
на странице cli.md
.
Порядок должен быть алфавитным, иначе в лог MkDocs будет выведена следующая запись со статусом WARNING
:
WARNING - check_sorting: INCORRECT SORTING @ reference/cli.md: ## picodata run {: #run }
Алгоритм:
- Хук выполняется в событии
on_page_markdown
только для страницыcli.md
- Из заголовков уровней
h2
иh3
формируется словарьindex
форматаdict[h2, list[h3]]
- Проверяются значения словаря
index
: если списокlist[h3]
не отсортирован по алфавиту, об этом выводится запись в лог MkDocs
Списки list[h3]
формируются из опций формата --<option>
, поэтому для данного хука следующий список отсортирован не по алфавиту:
### -a, --auth-type {: #connect_auth_type }
### -u, --user {: #connect_user }
### --password-file {: #connect_password_file }
Отсортированный список:
### -a, --auth-type {: #connect_auth_type }
### --password-file {: #connect_password_file }
### -u, --user {: #connect_user }
See:
- Close #190 (closed)
- Target branch:
main
- Changes should be cherry-picked to 24.1: NO
- Staging: https://docs.binary.picodata.io/picodata/branch-check-alphabetical-order/
Edited by Artur Sabirov