mkdocstrings-c

A C handler for mkdocstrings.

WARNING: Still in prototyping phase! Feedback is welcome.

NOTE: C99 full support, C11 partial support Since data is extraced with pycparser, only C99 is fully supported, while C11 is partially supported.

Installation

pip install mkdocstrings-c

Usage

With the following header file:

--8<-- "docs/snippets/hello.h"

Generate docs for this file with this instruction in one of your Markdown page:

::: path/to/hello.h

This will generate the following HTML:

::: docs/snippets/hello.h handler: c