Урок по Docker для Data Science для начинающих MLOps / Курс по Python с нуля
Читаем документацию к Python прямо в интерпретаторе
В Python есть возможность читать встроенную в код документацию с помощью двух инструментов, а также писать собственную. Рассмотрим, как это можно делать: Получаем документацию с помощью метода help() Вызов метода help(), возвращает полную справку о переданной функции/объекте. Синтаксис: print(help(<объект справки>) Например: Справка вернула полную информацию о List-e, включая методы его исходного кода(их намного больше, так как все перечислять слишком долго). Это работает со всеми стандартными функциями и объектами...
Генерация API-документации из docstrings на Python
Источник: Nuances of Programming Написание высококачественной документации для большого или сложного API упрощается простым, интуитивно понятным пакетом Python — pdoc3, включая также поддержку Markdown и LaTeX! Документация важна Все любят хорошую и полную документацию, особенно во время знакомства с новой библиотекой (хотя, даже и при миллионном её применении). Представьте, как бы вы себя чувствовали, если бы с веб-сайтов Scikit-learn или TensorFlow убрали всю документацию. Сразу ощущается беспомощность… Поэтому она важна...