Skip to content

feat: check sorting in reference/cli.md

Artur Sabirov requested to merge check_alphabetical_order into main

Описание

Добавлен хук check_sorting.py, который проверяет порядок следования подзаголовков --<option> на странице cli.md.

Порядок должен быть алфавитным, иначе в лог MkDocs будет выведена следующая запись со статусом WARNING:

WARNING -  check_sorting: INCORRECT SORTING @ reference/cli.md: ## picodata run {: #run }

Алгоритм:

  1. Хук выполняется в событии on_page_markdown только для страницы cli.md
  2. Из заголовков уровней h2 и h3 формируется словарь index формата dict[h2, list[h3]]
  3. Проверяются значения словаря 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:


Edited by Artur Sabirov

Merge request reports