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

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

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution for mkdocstrings-c 0.1.0
File	Size	Uploaded
mkdocstrings_c-0.1.0.tar.gz	48.5 kB	Mar 28, 2025	Details

Table of built distributions (wheels) for mkdocstrings-c 0.1.0
File	Interpreter	ABI	Platform	Reset
mkdocstrings_c-0.1.0-py3-none-any.whl 17.8 kB Mar 28, 2025	Python 3	none	any	Details

Total release size: 66.3 kB

Download URL	mkdocstrings_c-0.1.0.tar.gz
Size	48.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`832fe703e6e37b73b8d133138bafad2aaaaaaf303b924ccdb6c0f2b9683c7210`
BLAKE2b-256 checksum How to use checksums	`1ed93b06be391c39b2326333cce3568f4a29993a772718a3b036281b3dcd9d62`
Upload date	Mar 28, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.13.2`

Download URL	mkdocstrings_c-0.1.0-py3-none-any.whl
Size	17.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`8c6a5a702dd98e08897dc22f933855ff6301baaf88241940030124347606fee4`
BLAKE2b-256 checksum How to use checksums	`de5cc8a84c286baf6d85ae5885471193e5670f8aaea75c66d6f413be5f5aa8bc`
Upload date	Mar 28, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.13.2`