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

🛝 DJANGO PLAYLIST:

🎬 RECOMMENDED VIDEOS:
Django Models:

䷐ FOLLOW US:

🏷 TAGS:
#python #skillshats

Thanks!!
Enjoy 🤗

[udirt]

thank you - most people don't even *cover* automatic generation from code comments, they might have fancy videos, but much less useful. glad I found yours. I'm not a dev and just know "this should be possible in a better way" but need tutorials from someone who actually understands what they do.

[ramirojativa]

A perfect explanation of how to generate the self-documentation of a project in python using MkDocs The best I've seen in videos so far. I was stuck with Sphinx and hadn't heard of MkDocs until now. MkDocs has the ability to generate the self-documentation of the code (particularly Python) in my case in an automatic way and without the complications of Sphinx. Congratulations and thank you!

[mpetty]

Great video! Exactly what I needed to try out using MkDocs and mkdocstrings, works great.

[Tubaii]

This was a very helpful introduction. It helped me get started with MkDocs and mkdocstrings with ease. Thank you!

[shawn.builds]

was having some issues with the docs and this pushed me through. thanks!

[plashless]

amazing. Tried a lot but found you. Thanks man.

[KirankumarTamvada]

I have production-ready code with well-documented class-based functions. Is it safe to use this code, or is there any possibility that this library might inadvertently share our data internally? I need to be cautious and avoid any risks.

[LucasDesperrois]

There is one error where you install mkdocstring[python]. The command isn't : pip install "mkdocsstrings[python]" but pip install "mkdocstrings[python]"