Замена глобального файла описания всех пакетов на несколько более мелких #1049
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Если значение параметра 'sbu' из 'config.json' равно нулю, то это значение не генерируется. Поэтому такое неправильное значение не отображается для пакетов, которые не собираются во временной системе
Если значение параметра 'sbu' из 'config.json' равно нулю, то это значение не генерируется. Поэтому такое неправильное значение не отображается для пакетов, которые не собираются во временной системе
Различия: - Название пакета теперь заголовок второго уровня (##), а не первого (#), как было раньше; - Изменение внешнего вида этого блока. Если раньше было что-то вроде Пункт: **значение** (значение выделялось жирным шрифтом, то сейчас наоборот: **Пункт:** значение. Выглядит намного лучше. Использование: 'python3 ./tools/gen-info.py mode' Режимы работы (mode): - individual - сгенерировать отдельные страницы для каждого пакета; - prologue - сгенерировать файл prologue/packages.md TODO: - Рефакторинг кода. Две переменные 'info' с примерно одинаковым (и достаточно большим) содержимым никчему
Изменения: - В генераторе prologue/packages.md строка с SBU теперь правильно переносится, значения берутся из 'sbu2' - В строке 'Размер' теперь указывается единица измерения (Мб) (prologue, individual)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Файл
/docs/packages/packages.jsonочень сильно раздут, и внос в него изменений может быть затруднительным. Поэтому предлагаю заменить его на несколько более мелких файлов:/docs/packages/pkglist.json- список всех пакетов, необходим для/tools/gen-info.py, предназначенного для генерации markdown-файлов описаний каждого пакета;/docs/packages/$PACKAGE/config.json- файл с описанием пакета$PACKAGE. Строение такое же, как и у старогоpackages.json, ничего менять не нужно./tools/gen-info.py- скрипт для генерации файлов/docs/packages/$PACKAGE/README.mdс данными изconfig.json.Из отличий полученных README можно отметить:
#, он же<h1></h1>) отображается не только название пакета, как раньше, но и его версия.<p>), а используется перевод строки (<br />).Пункт: **значение**(значение выделялось жирным шрифтом, то сейчас наоборот:**Пункт:** значение. Выглядит намного лучше.***(он же<hr />) для отделения раздела с информацией о пакете от раздела с инструкциями по сборке пакета.Использование
mode- режим работы:individual- генерация только страниц с информацией для пакетов;prologue- генерация файлаprologue/packages.md.TODO
prologue/packages.mdс информацией обо всех пакетах.config.jsonпридётся добавлять новые параметры.info(достаточно большие по объёму!) никчему. Вconfig.get_base_info()не создавать словарь "вручную", а генерировать его на основе полученных из JSON'a данных. Тогда придётся менять названия ключей на одинаковые как в этом методе, так и во всём коде далее.