Build Your Python Project Documentation With MkDocs

Building Python Project Documentation With MkDocs

Darren Jones
Darren Jones 17 Lessons 49m intermediate projects tools
Start Now Rate and Review

In this course, you’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.

Maintaining auto-generated documentation means less effort because you’re linking information between your code and the documentation pages. However, good documentation is more than just the technical description pulled from your code! Your project will appeal more to users if you guide them through examples and connect the dots between the docstrings.

The Material for MkDocs theme makes your documentation look good without any extra effort and is used by popular projects such as Typer CLI and FastAPI.

In this course, you’ll:

  • Work with MkDocs to produce static pages from Markdown
  • Pull in code documentation from docstrings using mkdocstrings
  • Follow best practices for project documentation
  • Use the Material for MkDocs theme to make your documentation look good
  • Host your documentation on GitHub Pages

What’s Included:

Downloadable Resources:

Related Learning Paths:

Start Now

Building Python Project Documentation With MkDocs

4 Lessons 10m

  1. 1. Building Python Project Documentation With MkDocs (Overview)01:37
  2. 2. Project Demo and Details03:28
  3. 3. Preparing the Project Environment03:02
  4. 4. Creating the Sample Python Package02:20

Writing and Formatting Your Docstrings

6 Lessons 20m

  1. 1. Writing and Formatting Your Docstrings00:41
  2. 2. Understanding Python Docstrings03:43
  3. 3. Adding Function Docstrings04:15
  4. 4. Writing and Testing Examples03:27
  5. 5. Using Type Hints04:32
  6. 6. Adding Module Docstrings03:59

Preparing, Building, and Deploying Your Documentation

7 Lessons 18m

  1. 1. Preparing Your Documentation With MkDocs00:42
  2. 2. Creating Your MkDocs Project Structure03:39
  3. 3. Creating Static Pages From Markdown06:30
  4. 4. Building Your Documentation With MkDocs01:47
  5. 5. Hosting Your Documentation on GitHub03:17
  6. 6. Deploying Your Documentation to GitHub01:32
  7. 7. Building Python Project Documentation With MkDocs (Summary)01:25
Start Now

About Darren Jones

With 20 years as a teacher of music technology, Darren is keen to bring his skills to the Python table.

» More about Darren

Each tutorial at Real Python is created by a team of developers so that it meets our high quality standards. The team members who worked on this tutorial are:

Christopher

Kate

Tappan

Martin

Geir Arne

David

Aldren

Leodanis

Related Courses:

Documenting Python Projects With Sphinx and Read the Docs

Documenting Python Projects With Sphinx and Read the Docs

← Browse All Courses