Metadata-Version: 2.4
Name: mkdocstrings-c
Version: 0.1.0
Summary: A C handler for mkdocstrings.
Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
License-Expression: ISC
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Project-URL: Homepage, https://mkdocstrings.github.io/c
Project-URL: Documentation, https://mkdocstrings.github.io/c
Project-URL: Changelog, https://mkdocstrings.github.io/c/changelog
Project-URL: Repository, https://github.com/mkdocstrings/c
Project-URL: Issues, https://github.com/mkdocstrings/c/issues
Project-URL: Discussions, https://github.com/mkdocstrings/c/discussions
Project-URL: Gitter, https://gitter.im/mkdocstrings/c
Project-URL: Funding, https://github.com/sponsors/pawamoy
Requires-Python: >=3.9
Requires-Dist: mkdocstrings>=0.28.3
Requires-Dist: pycparser>=2.20
Description-Content-Type: text/markdown

# mkdocstrings-c

[![ci](https://github.com/mkdocstrings/c/workflows/ci/badge.svg)](https://github.com/mkdocstrings/c/actions?query=workflow%3Aci)
[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/c/)
[![pypi version](https://img.shields.io/pypi/v/mkdocstrings-c.svg)](https://pypi.org/project/mkdocstrings-c/)
[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#c:gitter.im)

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](https://github.com/eliben/pycparser), only C99 is fully supported, while C11 is partially supported.

## Installation

```bash
pip install mkdocstrings-c
```

## Usage

With the following header file:

```c title="hello.h"
--8<-- "docs/snippets/hello.h"
```

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

```md
::: path/to/hello.h
```

This will generate the following HTML:

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