📱Code Embedder.

Code Embedder — это GitHub Action, который автоматически обновляет кодовые фрагменты в ваших markdown (README) файлах. Он находит блоки кода, ссылающиеся на определенные скрипты, и заменяет их актуальным содержимым. Это помогает держать документацию в синхронизации с кодом.

🔧Основные функции:

🔘Автосинхронизация: поддерживайте примеры кода в README актуальными без ручного вмешательства.

🔘Простая настройка: добавьте действие в GitHub workflow и форматируйте блоки кода в README.

🔘Поддержка секций: обновляйте только нужные части скрипта в README.

🔘Поддержка объектов: обновляйте только определенные объекты (функции, классы) в README.

✅Code Embedder позволяет сосредоточиться на коде, в то время как действие позаботится об актуальности документации, снижая риск устаревших или неверных примеров в проекте.

#CodeEmbedder #GitHubActions #Python #Automation #Documentation #CodeSync #DevTools

📱Ссылка на репозиторий:
https://github.com/kvankova/code-embedder

📱Zensical.

Zensical — современный генератор статических сайтов от создателей Material for MkDocs.

Если вам нужна красивая, удобная и профессиональная документация — Zensical позволяет получить её буквально за считанные минуты. Пишите всё в Markdown, а дальше он сам собирает быстрый, адаптивный и полностью статический сайт.

❓Почему Zensical стоит попробовать:

🔘Быстрый старт — превратите Markdown в готовую документацию без сложностей.

🔘Встроенный умный поиск.

🔘Гибкая кастомизация и расширяемость.

🔘Поддержка более 60 языков.

🔘Подходит для Open Source и коммерческих продуктов.

🔘Идеально отображается на любых устройствах.

✅Создатели Material for MkDocs снова сделали инструмент, который сочетает удобство, мощность и простой рабочий процесс.

✅Если вы хотите документацию, которая выглядит как продукт — Zensical справится.

#documentation #markdown #static #mkdocs #materialformkdocs #zensical #python #developers #opensource

📱Ссылка на репозиторий:
https://github.com/zensical/zensical

📱Linklint.

Linklint — это полезное расширение для Sphinx и консольный линтер, который очищает вашу Python-документацию от избыточных и отвлекающих ссылок.

Когда документация разрастается, в .rst файлах часто скапливается визуальный шум: ссылки, ведущие сами на себя, или десятки одинаковых ссылок в одном абзаце. Linklint решает эту проблему элегантно и без лишних усилий.

🔹Главные фичи (проверки):

🔘self: находит ссылки, которые ведут на свой же раздел. Например, если в описании класса вы используете :class: для ссылки на этот же класс, инструмент сделает её обычным текстом, так как она никуда вас не уведет.

🔘paradup: ищет дублирующиеся ссылки внутри одного абзаца. Первая ссылка остается активной, а все последующие отключаются, чтобы не отвлекать читателя.

⚙️Два режима работы:

🔘Расширение Sphinx: Идеальный вариант. Просто добавьте "linklint.ext" в ваш conf.py. Инструмент очистит лишние ссылки на этапе сборки документации, вообще не изменяя ваши исходные файлы.

🔘CLI-линтер: Можно запустить в терминале (например, linklint --fix files...), чтобы он нашел избыточные вызовы и жестко зафиксировал изменения прямо в коде, добавив восклицательный знак (превратив :func:foo в :func:!foo).

💡Интересный факт: Инструмент активно развивается (последняя версия 0.4.1 вышла в марте 2026 года и поддерживает Sphinx 8.x/9.x). При прогоне через документацию самого CPython, Linklint автоматически убрал более 3600 лишних ссылок!

#Python #Sphinx #Documentation #DevTools #OpenSource #Linklint

📱Ссылка на репозиторий:
https://github.com/nedbat/linklint