2 года назад
Генерация API-документации из docstrings на Python
Источник: Nuances of Programming Написание высококачественной документации для большого или сложного API упрощается простым, интуитивно понятным пакетом Python  —  pdoc3, включая также поддержку Markdown и LaTeX! Документация важна Все любят хорошую и полную документацию, особенно во время знакомства с новой библиотекой (хотя, даже и при миллионном её применении). Представьте, как бы вы себя чувствовали, если бы с веб-сайтов Scikit-learn или TensorFlow убрали всю документацию. Сразу ощущается беспомощность… Поэтому она важна...
Что такое Markdown?
Простой текстовый документ удобен практически всем, кроме одного - нет возможности отформатировать и разметить текст. Нельзя сделать текст полужирным или курсивом, создать таблицу, нумерованный список, выделить программный код или написать математическую формулу. Конечно, для этого можно использовать текстовый процессор, например LibreOffice Writer или аналогичный. Но у текстового процессора есть свои минусы: требует установки (не всегда, но это отдельный разговор), отсутствует универсальность и лёгкость разметки, да и размер файла не самый маленький...