Join us and get access to thousands of tutorials and a community of expert Pythonistas.

This lesson is for members only. Join us and get access to thousands of tutorials and a community of expert Pythonistas.

Preparing Your Documentation With MkDocs

Building Python Project Documentation With MkDocs Darren Jones 00:42

00:00 Prepare Your Documentation With MkDocs.

00:05 At this point, you should have an activated virtual environment with all the necessary packages installed. You should also have set up your toy calculator package and added docstrings to your code. In this part of the course, you’ll set up your mkdocs.yml file, which will hold the instructions for building the documentation with MkDocs.

00:25 You’ll write your additional documentation pages in Markdown, including the syntax that defines where mkdocstrings will insert the auto-generated part of your documentation.

00:37 So let’s begin that process by creating the project structure.

Become a Member to join the conversation.