Creating Documentation With MkDocs & When to Use a Python dict | Real Python Podcast
How do you start building your project documentation? What if you had a tool that could do the heavy lifting and automatically write large portions directly from your code? This week on the show, Christopher Trudeau is here, bringing another batch of PyCoder's Weekly articles and projects.
👉 Links from the show: https://realpython.com/podcasts/rpp/118/
We talk about a Real Python step-by-step project from Martin Breuss about Mkdocs. The project walks you through generating nice-looking and modern documentation from Markdown files and your existing code's docstrings. The final step is to deploy your freshly generated documentation to a GitHub repository.
Christopher talks about a pair of articles arguing for and against using Python dictionaries. The first article, "Just Use Dictionaries", pushes to keep things simple, while the second article, "Don't Let Dicts Spoil Your Code", contends complex projects require something more specific.
We cover several other articles and projects from the Python community, including discussing the recent beta release of Python 3.11, 2FA for PyPI, procedural music composition with arvo, building a tic-tac-toe game with Python and Tkinter, a discussion covering common issues encountered while coding in Python, a type-safe library to generate SVG files, and a lightweight static analysis tool for your projects.
Topics:
00:00:00 -- Introduction
00:02:39 -- Python 3.11 Release May Be Delayed
00:03:39 -- The cursed release of Python 3.11.0b4 is now available
00:05:01 -- PyPI 2FA Security Key Giveaway
00:08:01 -- Build Your Python Project Documentation With MkDocs
00:14:12 -- Don't Let Dicts Spoil Your Code
00:16:22 -- Just Use Dictionaries
00:20:12 -- Sponsor: Snyk.io
00:20:51 -- Procedural Music Composition With arvo
00:29:10 -- Build a Tic-Tac-Toe Game With Python and Tkinter
00:33:59 -- Video Course Spotlight
00:35:35 -- Most Common Issue You Have Coding With Python?
00:45:00 -- svg.py: Type-Safe Library to Generate SVG Files
00:48:27 -- semgrep: Lightweight Static Analysis for Many Languages
00:53:46 -- Thanks and goodbye
👉 Links from the show: https://realpython.com/podcasts/rpp/118/
On this page of the site you can watch the video online Creating Documentation With MkDocs & When to Use a Python dict | Real Python Podcast with a duration of hours minute second in good quality, which was uploaded by the user Real Python 22 July 2022, share the link with friends and acquaintances, this video has already been watched 1,896 times on youtube and it was liked by 31 viewers. Enjoy your viewing!
