Публикации по тегам documentation

Публикации по теме 'documentation'

Как сгенерировать документацию для кода Python с помощью pdoc

Английский не является моим родным языком, и я пытаюсь улучшить свои знания, любые отзывы приветствуются. Сегодня я потратил несколько часов на поиск простого способа создания документации для университетского проекта, над которым я работаю. Проект написан на Python . Я попробовал pydoc , но мне не понравился дизайн создаваемой им HTML-страницы, в конце концов я нашел pdoc . Pdoc - это программное обеспечение, которое можно использовать для создания документации для..

StackOverflow - это симптом, а не решение

Вначале Программист создал Код и Документацию. Документация была краткой и недоступной, двусмысленно объясненные функции были глубоко скрыты, а ошибочное облако невежества витало над скопившимися младшими. И Программист сказал: пусть будет больше кода, и будет больше кода. Программист увидел, что код хорош, и назвал его Framework. И был Code, и был Framework в первый день. И это, дамы и господа, мальчики и девочки, инопланетяне и супергерои, - это, по сути, Genesis современного..

Как задокументировать ES6 JavaScript API с помощью JSDoc (Часть 2 - Глобальные участники)

Это вторая часть серии. Первую часть вы можете найти здесь: Введение . В этом посте мы рассмотрим, как использовать JSDoc для документирования глобальных членов JavaScript. Глобальные члены - отличный вариант использования для начала нашего путешествия по JSDoc, просто имейте в виду, что использование глобальных переменных или функций, как правило, не рекомендуется в реальном коде. Начнем с базового примера, документирующего глобальную переменную: Давайте посмотрим на..

Шпаргалка по Alpine.js, созданная с помощью Alpine.js

У меня были проблемы с документацией Shopify на протяжении многих лет, но я должен отдать им должное там, где это необходимо, — и время от времени я наслаждался их Liquid Cheatsheet. Вдохновленный упомянутой шпаргалкой, я хотел создать быструю сводную шпаргалку для директив и магических свойств Alpine.js. И так уж вышло, что Alpine.js оказался идеальным маленьким инструментом для того, чтобы собрать все воедино! Как Мета!!! Веб-сайт: https://xcheat.jamesauble.com Репо:..

Как добавить образцы кода в ReDoc в FastAPI

Расширение схемы OpenAPI для лучшей документации Прочитав этот фрагмент, вы научитесь изменять сгенерированную схему OpenAPI и добавлять образцы кода в ReDoc конечную точку в вашем приложении FastAPI. В этом руководстве также рассматривается динамическое добавление образцов кода из текстовых файлов вместо определения кода внутри вашего сценария FastAPI. Начиная с версии 2.0, ReDoc предоставляет отличную поддержку примеров кода через расширение поставщика . Все, что вам нужно..

Метод науки о данных (DSM) - Документация

Это шестая и последняя статья в серии о том, как вывести ваши проекты в области науки о данных на новый уровень, используя методологический подход, аналогичный научному методу, основанному на Data Science Method. Эта статья посвящена этапу документирования, который включает в себя: Просмотр результатов моделирования Представление и обмен вашими выводами (рассказывание историй) Завершение кода Завершение работы над модельной документацией Если вы пропустили предыдущие статьи в этой..

Самый быстрый, грязный, автоматический… есть Vue Documenter когда-либо

Узрите, Документатор Компонента Vue… Компонент Автор Ян Джонсон , старший инженер по фронтенду в Skilljar Рассматриваемый Vue Documenter, чтобы вы могли следить за ним дома - NPM - https://www.npmjs.com/package/vue-documenter GitHub - https://github.com/theianjohnson/vue-documenter Я один из трех интерфейсных инженеров в нашей команде, состоящей из примерно десятка бэкенд-инженеров, а это значит, что при развертывании компонентов всей команды нужно поддерживать..