Real Python
  • Start Here
  • Learn Python
    Python Tutorials →
    In-depth articles and video courses     Learning Paths →
    Guided study plans for accelerated learning     Quizzes & Exercises →
    Check your learning progress     Browse Topics →
    Focus on a specific area or skill level     Community Chat →
    Learn with other Pythonistas     Office Hours →
    Live Q&A calls with Python experts     Podcast →
    Hear what’s new in the world of Python     Books →
    Round out your knowledge and learn offline     Reference →
    Concise definitions for common Python terms     Code Mentor →Beta
    Personalized code assistance & learning tools     Unlock All Content →
  • More
    Learner Stories Python Newsletter Python Job Board Meet the Team Become a Tutorial Writer Become a Video Instructor
  • Search
/
  • Join
  • Sign‑In

— FREE Email Series —

🐍 Python Tricks 💌

Python Tricks Dictionary Merge

🔒 No spam. Unsubscribe any time.

Browse Topics Guided Learning Paths
Basics Intermediate Advanced
ai algorithms api best-practices career community databases data-science data-structures data-viz devops django docker editors flask front-end gamedev gui machine-learning news numpy projects python stdlib testing tools web-dev web-scraping

Table of Contents

  • Demo
  • Project Overview
  • Prerequisites
  • Step 1: Set Up Your Environment for Building Documentation
  • Step 2: Create the Sample Python Package
  • Step 3: Write and Format Your Docstrings
    • Understand Python Docstrings
    • Add Function Docstrings to Your Python Project
    • Write Examples and Test Them Using Doctest
    • Use Type Hints to Provide Automatic Type Information
    • Add Module Docstrings
  • Step 4: Prepare Your Documentation With MkDocs
    • Create Your MkDocs Project Structure
    • Adapt Your Project Settings File
    • Create Static Pages From Markdown
    • Insert Information From Docstrings
  • Step 5: Build Your Documentation With MkDocs
  • Step 6: Host Your Documentation on GitHub
    • Create a GitHub Repository
    • Deploy Your Documentation to GitHub
  • Conclusion
  • Next Steps

Recommended Video Course
Building Python Project Documentation With MkDocs