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! → / @skillshats
🛝 DJANGO PLAYLIST:
• Django
🎬 RECOMMENDED VIDEOS:
Django Models:
→ • Add record in Django model | Python
→ • Add record in Django model | Python
→ • Update & Delete record in Django Mode...
䷐ FOLLOW US:
Website: https://skillshats.com
Twitter: / skillshats
Facebook: / skillshats
🏷 TAGS:
#python #skillshats
Thanks!!
Enjoy 🤗
En esta página del sitio puede ver el video en línea Auto Generated Documentation using MkDocs + MkDocStrings | Python de Duración hora minuto segunda en buena calidad , que subió el usuario SkillsHats 25 diciembre 2022, comparta el enlace con amigos y conocidos, en youtube este video ya ha sido visto 6,099 veces y le gustó 65 a los espectadores. Disfruta viendo!
