Linklint — это полезное расширение для Sphinx и консольный линтер, который очищает вашу Python-документацию от избыточных и отвлекающих ссылок.
Когда документация разрастается, в
.rst файлах часто скапливается визуальный шум: ссылки, ведущие сами на себя, или десятки одинаковых ссылок в одном абзаце. Linklint решает эту проблему элегантно и без лишних усилий.:class: для ссылки на этот же класс, инструмент сделает её обычным текстом, так как она никуда вас не уведет."linklint.ext" в ваш conf.py. Инструмент очистит лишние ссылки на этапе сборки документации, вообще не изменяя ваши исходные файлы.linklint --fix files...), чтобы он нашел избыточные вызовы и жестко зафиксировал изменения прямо в коде, добавив восклицательный знак (превратив :func:foo в :func:!foo).#Python #Sphinx #Documentation #DevTools #OpenSource #Linklint
https://github.com/nedbat/linklint
Please open Telegram to view this post
VIEW IN TELEGRAM
GitHub
GitHub - nedbat/linklint: A Sphinx extension to reduce excessive linking
A Sphinx extension to reduce excessive linking. Contribute to nedbat/linklint development by creating an account on GitHub.
1👍3🔥3 1