Skip to content

Fund this project through sponsorship — Follow @pawamoy on Fosstodon for updates

Griffe

Docstrings

Initializing search

mkdocstrings/griffe

Home
Getting started
Guide
Extensions
Reference
Changelog
Insiders
Author's website

Griffe

mkdocstrings/griffe

Home
Getting started
Getting started
- Installation
- Introduction
- Playground
- License
- Community
  Community
Guide
Guide
- User guide
  User guide
  - Manipulating APIs
    Manipulating APIs
    
    Loading
    
    Navigating
    
    Serializing
    
    Checking
    
    Extending
  - Recommendations
    Recommendations
    
    Public APIs
    
    Python code
    
    Docstrings
  - How-to
    How-to
    
    Parse docstrings
    
    Support custom decorators
    
    Selectively inspect objects
    
    Set objects' docstring style
- Contributor guide
  Contributor guide
Extensions
Extensions
- Built-in
  Built-in
  - dataclasses
- Official
  Official
- Third-party
  Third-party
Reference
Reference
- Command-line interface
- Docstring parsers
- Python API
  Python API
  - CLI entrypoints
  - Loaders
  - Finder
  - Models
    
    Models
    
    Module
    
    Class
    
    Function
    
    Attribute
    
    Alias
  - Agents
  - Serializers
  - API checks
  - Extensions
  - Docstrings
    
    Docstrings
    
    Models
    
    Parsers
  - Exceptions
  - Expressions
  - Git utilities
  - Loggers
  - Helpers
Changelog
Insiders
Insiders
- Getting started
  Getting started
  - Installation
  - Changelog
Author's website

Home
Reference
Python API

Docstrings¤

Docstrings are parsed and the extracted information is structured in models.

2024-07-13 2024-07-10

Was this page helpful?

Thanks for your feedback!

Let us know how we can improve this page.

Feedback

Copyright © 2021 Timothée Mazzucotelli

Made with Material for MkDocs Insiders