Город МОСКОВСКИЙ
00:11:25

Документация как код с помощью MkDocs

Аватар
luferov
Просмотры:
85
Дата загрузки:
20.07.2025 21:50
Длительность:
00:11:25
Категория:
Обучение

Описание

Разбираясь в генерации документации как кода, сгенерировал для Вас сайт с материалами, которые я пишу о системной архитектуре.

🚀 URL: https://luferov.github.io/architecture/
📙 REPO: https://github.com/Luferov/architecture

Сделал на github-pages.

А вообще программисты не любят писать документацию, ну чтож, а как же писать docstring. Вроде писать docstring нормально, docstring на модуль, на класс, на методы, на функции, а потом генерируем на основе mkdocs-string https://mkdocstrings.github.io. А если добавить линтер на докстринги? Получится актуальная документация к актуальному коду.

Рекомендуемые видео