Skip to content

MkDocstrings Configuration

Coming Soon

This comprehensive guide to MkDocstrings configuration is currently under development. Soon you'll learn how to automatically generate API documentation from your Python docstrings.

What This Page Will Cover

This guide will explain:

  • Installation: Setting up MkDocstrings and its handlers
  • Basic Configuration: Essential mkdocs.yml settings
  • Python Handler: Configuring the Python handler options
  • Docstring Styles: Supporting Google, NumPy, and Sphinx styles
  • Customization: Theming and styling your API docs
  • Advanced Features: Cross-references, inheritance, and more

Quick Start

While this page is being completed, here's a basic configuration:

# mkdocs.yml
plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true

Basic Usage

# API Documentation

::: my_module.MyClass
    options:
      show_source: true
      show_bases: true

Supported Docstring Styles

  1. Google Style - Clean and readable
  2. NumPy Style - Structured sections
  3. Sphinx Style - reStructuredText format

Last updated: December 2024