Auto Generated Documentation using MkDocs + MkDocStrings | Python
In this video, We'll learn how to quickly build documentation for a Python package using MkDocs and mkdocstrings. These tools allow you to generate nice-looking and modern documentation from Markdown files and your code’s docstrings.
What is MkDocs?
MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
Install MkDocs - pip install mkdocs
What is MkDocStrings?
MkDocStrings is python library that we can use to generate mkdocs with the help of code docstrings.
Install MkDocStrings - pip install mkdocstrings
Video Content Timelines:
00:00 - Introduction
00:25 - Sample MkDoc Setup
03:27 - Install MkDocs Library
04:05 - Create MkDocs Project
05:34 - Run MkDocs Locally
07:14 - Create Custom Markdown File
10:12 - Install MkDocsString-Python
11:00 - Setup mkdocstrings-python plugin
14:40 - Write DocStrings in methods
17:10 - Write Examples in DocStrings
17:58 - Build MkDocs Site
18:40 - Customize MkDocs Default Settings
20:15 - MkDocs Theme
? If you enjoyed this content, give the video a like. If you want to watch more upcoming videos, consider subscribing to the channel! → https://www.youtube.com/channel/UCv7P0Mnb3JgX7WqUW4ukDOw?sub_confirmation=1
? DJANGO PLAYLIST:
https://youtube.com/playlist?list=PLI7bO1gtm1IgC-iw_xhb98qU_NKCJarxd
? RECOMMENDED VIDEOS:
Django Models:
→ https://youtu.be/zPB_d26J7qQ
→ https://youtu.be/zPB_d26J7qQ
→ https://youtu.be/3yIiNnV29vg
䷐ FOLLOW US:
Website: https://skillshats.com
Twitter: https://www.twitter.com/skillshats
Facebook: https://www.facebook.com/skillshats
? TAGS:
#python #skillshats
Thanks!!
Enjoy ?
Что делает видео по-настоящему запоминающимся? Наверное, та самая атмосфера, которая заставляет забыть о времени. Когда вы заходите на RUVIDEO, чтобы посмотреть онлайн «Auto Generated Documentation using MkDocs + MkDocStrings | Python», вы рассчитываете на нечто большее, чем просто загрузку плеера. И мы это понимаем. Контент такого уровня заслуживает того, чтобы его смотрели в HD 1080, без дрожания картинки и бесконечного буферизации.
Честно говоря, Rutube сегодня — это кладезь уникальных находок, которые часто теряются в общем шуме. Мы же вытаскиваем на поверхность самое интересное. Будь то динамичный экшн, глубокий разбор темы от любимого автора или просто уютное видео для настроения — всё это доступно здесь бесплатно и без лишних формальностей. Никаких «заполните анкету, чтобы продолжить». Только вы, ваш экран и качественный поток.
Если вас зацепило это видео, не забудьте взглянуть на похожие материалы в блоке справа. Мы откалибровали наши алгоритмы так, чтобы они подбирали контент не просто «по тегам», а по настроению и смыслу. Ведь в конечном итоге, онлайн-кинотеатр — это не склад файлов, а место, где каждый вечер можно найти свою историю. Приятного вам отдыха на RUVIDEO!
Видео взято из открытых источников Rutube. Если вы правообладатель, обратитесь к первоисточнику.