Modern Python Projects Transcripts
Chapter: Documentation
Lecture: MkDocs

Login or purchase this course to watch this video and the rest of the course contents.
0:00 But what if you don't want to use sphinx? Maybe you don't like the restructure text formatter.
0:06 You're looking for something else. So another popular tool to manage documentation is called
0:11 mkdocs. Okay. mkdocs is using markdown format and similar to sphinx, It has a configuration file, but this time in the YAML format.
0:23 Otherwise it works very similar to how sphinx, works. So first you have to install it with pip.
0:30 Then you have to generate the new mkdocs project and inside you just create markdown files with documentation for your project.
0:42 Then you just need to run mkdocs serve command, and this will generate the documentation. You can go to the local host. URL to see this in the browser.
0:57 What I really like about mkdocs is how the search feature works. It's very easy and fast to find whatever you're looking for,
1:05 you can also customize it and use a different theme if you like. And if you want to publish your documentation somewhere,
1:12 read. The docs also support mkdocs.

Talk Python's Mastodon Michael Kennedy's Mastodon