A comprehensive guide to asynchronous programming in Python with practical examples.

• 1,171 lines of comprehensive documentation
• 9 guide sections from introduction to advanced patterns
• 12 example files with 4,437 lines of well-commented code
• Full MkDocs website with Material theme

# Activate virtual environment
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Start the development server
mkdocs serve

# Visit http://127.0.0.1:8000 in your browser

cd examples
python 01_basic_async.py
python 02_sequential_vs_concurrent.py
# ... and so on

docs/
├── index.md                 # Landing page
├── guide/                   # 9 comprehensive guide sections
│   ├── introduction.md
│   ├── core-concepts.md
│   ├── fundamentals.md
│   ├── intermediate.md
│   ├── advanced.md
│   ├── real-world.md
│   ├── best-practices.md
│   ├── common-pitfalls.md
│   └── quick-reference.md
├── examples/                # Example documentation pages
│   ├── beginner/           # 3 beginner examples
│   ├── intermediate/       # 5 intermediate examples
│   └── advanced/           # 4 advanced examples
└── resources/              # Additional learning resources

# Build static site
mkdocs build

# Output will be in site/ directory

• ✅ Multi-page structure with easy navigation
• ✅ Material for MkDocs theme with dark/light mode
• ✅ Code syntax highlighting with copy buttons
• ✅ Search functionality across all content
• ✅ Mobile responsive design
• ✅ Custom CSS with difficulty badges
• ✅ Navigation tabs and breadcrumbs

1. Introduction
2. Core Concepts
3. Basic Async Example

1. Quick Reference
2. Intermediate Topics
3. Semaphores Example

1. Best Practices
2. Error Handling Example
3. Real-World API Client

All managed in requirements.txt:

• mkdocs>=1.5.3
• mkdocs-material>=9.5.0
• mkdocs-git-revision-date-localized-plugin>=1.2.0
• mkdocs-minify-plugin>=0.7.0
• pymdown-extensions>=10.5.0

The site is configured via mkdocs.yml with:

• Material theme settings
• Navigation structure
• Markdown extensions
• Plugins (search, minify, git dates)
• Custom CSS and JavaScript

• mkdocs.yml - Main configuration
• requirements.txt - Python dependencies
• docs/ - All documentation source files
• examples/ - 12 Python example files
• site/ - Generated static site (gitignored)

Custom styling is in:

• docs/stylesheets/extra.css - Custom CSS
• docs/javascripts/extra.js - Custom JavaScript

For local viewing only (as configured). To deploy:

mkdocs gh-deploy

• Build command: mkdocs build
• Publish directory: site

The original guide is preserved at async_await_guide.md for reference.

The documentation pages are split from the main guide. To update:

1. Edit the relevant file in docs/guide/ or docs/examples/
2. Rebuild with mkdocs build
3. Test with mkdocs serve

Educational purposes. Feel free to use and modify for learning.

Happy Learning! 🐍⚡