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
Sponsors
Metadata
Release files for mkdocstrings-c 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocstrings_c-0.1.1.tar.gz | 39.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocstrings_c-0.1.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 57.5 kB
Release files / mkdocstrings_c-0.1.1.tar.gz
| Download URL | mkdocstrings_c-0.1.1.tar.gz |
|---|---|
| Size | 39.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
078c63794944254149d3395e90a2e7862aa37584a857159403e6b37b5fcdbe9f
|
|
BLAKE2b-256 checksum How to use checksums |
5466c33f715381607e99cd57af822e95ac411d1d950c94f8c701135d70f95c41
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.8
|
Release files / mkdocstrings_c-0.1.1-py3-none-any.whl
| Download URL | mkdocstrings_c-0.1.1-py3-none-any.whl |
|---|---|
| Size | 17.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6d8f995947cf21b18130576cf5915adc001246fe192edc9c895116c88eb919c8
|
|
BLAKE2b-256 checksum How to use checksums |
0e430f29f1a1b8b0f9e7eb232e69ded0e5af8fdd7e72fed237cae574973df69e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.8
|