Skip to content

Commit 7237873

Browse files
committed
docs: Update downstream projects page
1 parent 3cccf27 commit 7237873

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

docs/downstream-projects.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
# Downstream projects
22

3-
Griffe is used by various projects in the Python ecosystem. They are listed below in alphabetical order.
3+
Griffe is used by various projects in the Python ecosystem. They are listed below in alphabetical order. [Griffe extensions are listed on their own page.](extensions.md)
44

55
## api2mdx
66

77
[api2mdx](https://github.com/Mirascope/api2mdx) is a Python tool that generates `mdx` documentation for Python APIs. Under the hood, it uses Griffe.
88

9+
## Cybersecurity AI (CAI)
10+
11+
[Cybersecurity AI (CAI)](https://github.com/aliasrobotics/cai) is a lightweight, open-source framework that empowers security professionals to build and deploy AI-powered offensive and defensive automation. It uses Griffe to parse docstrings in order to generate function schema for MCP tools. I believe it reused code from Pydantic AI.
12+
913
## Fumadocs
1014

1115
[Fumadocs](https://fumadocs.dev/) is a beautiful documentation framework for developers, flexible, performant, running on your React framework. It uses Griffe to extract and render Python API documentation.
@@ -30,6 +34,10 @@ Griffe is used by various projects in the Python ecosystem. They are listed belo
3034

3135
[mdxify](https://github.com/zzstoatzz/mdxify) generates API documentation from Python modules with automatic navigation and source links. MDX is the default output and Markdown is also supported via `--format md`.
3236

37+
## Mistral AI Python Client
38+
39+
The [Python client of Mistral AI](https://github.com/mistralai/client-python) uses Griffe to parse docstrings of Python-written MCP tools.
40+
3341
## mkdocstrings-python
3442

3543
Of course, Griffe is what powers [the Python handler of mkdocstrings](https://mkdocstrings.github.io/python/). mkdocstrings is a plugin for [MkDocs](https://www.mkdocs.org/) that allows rendering API docs easily.
@@ -49,11 +57,3 @@ The [OpenAI Agents SDK](https://github.com/openai/openai-agents-python) is a lig
4957
## quartodoc
5058

5159
[quartodoc](https://machow.github.io/quartodoc/) lets you quickly generate Python package API reference documentation using Markdown and [Quarto](https://quarto.org/). quartodoc is designed as an alternative to [Sphinx](https://www.sphinx-doc.org/en/master/). It uses Griffe to load API data and parse docstrings in order to render HTML documentation, just like [mkdocstrings-python](https://mkdocstrings.github.io/python/), but for Quarto instead of Mkdocs.
52-
53-
## rafe
54-
55-
[rafe](https://pypi.org/project/rafe/) is a tool for inspecting Python environments and building packages (irrespective of the language) in a reproducible manner. It wraps Griffe to provide a CLI command to check for API breaking changes.
56-
57-
## Yapper
58-
59-
[Yapper](https://pypi.org/project/yapper/) converts Python docstrings to `astro` files for use by the [Astro](https://astro.build/) static site generator. It uses Griffe to parse Python modules and extracts Numpydoc-style docstrings.

0 commit comments

Comments
 (0)