A C handler for mkdocstrings.
Project description
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mkdocstrings_c-0.1.0.tar.gz.
File metadata
- Download URL: mkdocstrings_c-0.1.0.tar.gz
- Upload date:
- Size: 48.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
832fe703e6e37b73b8d133138bafad2aaaaaaf303b924ccdb6c0f2b9683c7210
|
|
| MD5 |
345cb3466b9120cc3590d22f768571ea
|
|
| BLAKE2b-256 |
1ed93b06be391c39b2326333cce3568f4a29993a772718a3b036281b3dcd9d62
|
File details
Details for the file mkdocstrings_c-0.1.0-py3-none-any.whl.
File metadata
- Download URL: mkdocstrings_c-0.1.0-py3-none-any.whl
- Upload date:
- Size: 17.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8c6a5a702dd98e08897dc22f933855ff6301baaf88241940030124347606fee4
|
|
| MD5 |
fc2ad391509124d51488febe76324ab6
|
|
| BLAKE2b-256 |
de5cc8a84c286baf6d85ae5885471193e5670f8aaea75c66d6f413be5f5aa8bc
|
