User guide¤

For users and integrators

This guide explains how to use Griffe in your projects. To change Griffe itself, see the contributor guide.

Learn how to load, navigate, serialize, and check APIs, then configure Griffe for your project's needs.

Manipulating APIs¤

The following topics will guide you through the various methods Griffe offers for exploring and exploiting Python APIs.

Loading

Griffe can find packages and modules to scan them statically or dynamically and extract API-related information.

Learn how to load data
Navigating

Griffe exposes the extracted API information into data models, making it easy to navigate your API.

Learn how to navigate data
Serializing

Griffe can serialize your API data into JSON, for other tools to navigate or manipulate it.

Learn how to serialize data
Checking

Griffe can compare snapshots of the same API to find breaking changes.

Learn how to detect and handle breaking changes
Extending

API data can be augmented or modified thanks to Griffe's extension system.

Learn how to write and use extensions

These topics explore the user side: how to write code to better integrate with Griffe.

Public API

See our recommendations for exposing public APIs to your users.

See our public API recommendations
Python code best practices

See our best practices for writing Python code.

See our best practices
Docstrings

Griffe supports multiple docstring styles. Learn about these different styles, and see our recommendations to write docstrings.

See our docstring recommendations

These how-tos will show you how to achieve specific things with Griffe.

Parse docstrings

Griffe can be used as a docstring-parsing library.

See how to parse docstrings
@ Support custom decorators

Griffe will rarely support custom decorators through static analysis, but you can easily write extensions to do so.

See how to support custom decorators
Selectively inspect objects

Sometimes static analysis is not enough, so you might want to use dynamic analysis (inspection) on certain objects.

See how to selectively inspect objects
Set objects' docstring style

Sometimes the wrong docstring styles are attached to objects. You can fix this with a few different methods.

See how to set the correct docstring styles on objects
Set Git source info on objects

Griffe tries to find the right Git remote URL to provide source links to loaded objects. In some cases you might want to override the Git information or the source link directly.

See how to set the correct Git information or source link on objects