mkdocstrings-zig

A Zig handler for mkdocstrings. Makes it possible to create documentation from code in Zig language using mkdocs.

Demo

See demo documentation generated from test_zig_project.

Usage

Installation

pip install 'mkdocstrings[zig]'
pip install mkdocs-material
pip install typing-extensions

mkdocs-material theme installation is optional, but recommended for better look and feel.

mkdocs.yml example

site_name: Example of zig project documentation using mkdocstrings

# remove if you are not using mkdocs-material theme
# or replace it with the theme of your choice
theme:
  name: material

plugins:
- mkdocstrings:
    default_handler: zig

docs/index.md example

# Project Documentation

::: src/main.zig

::: src/root.zig

Or add documentation for a directory:

::: src

Metadata

Release files for mkdocstrings-zig 0.0.7

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

Source distribution (sdist)

Source distribution for mkdocstrings-zig 0.0.7
File	Size	Uploaded
mkdocstrings_zig-0.0.7.tar.gz	38.1 kB	Jul 24, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdocstrings-zig 0.0.7
File	Interpreter	ABI	Platform	Reset
mkdocstrings_zig-0.0.7-py3-none-any.whl 19.0 kB Jul 24, 2025	Python 3	none	any	Details

Total release size: 57.1 kB

Release files / mkdocstrings_zig-0.0.7.tar.gz

Download URL	mkdocstrings_zig-0.0.7.tar.gz
Size	38.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`f55dbb8398e9ad204525c3b70789f2e8ad789b8c515c27f292d426302663fe64`
BLAKE2b-256 checksum How to use checksums	`c9b71d51c9a330f373e11c88717c3c764c247849ed63d052f15d9dccbd584f10`
Upload date	Jul 24, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.12.8`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/insolor/mkdocstrings-zig
Publishing commit: github.com/insolor/mkdocstrings-zig/tree/eb08156177ce897de3a349443cc56ece747c09eb

Workflow

Publishing configuration: github.com/insolor/mkdocstrings-zig/blob/eb08156177ce897de3a349443cc56ece747c09eb/.github/workflows/release.yml
Publishing logs: github.com/insolor/mkdocstrings-zig/actions/runs/16501218430/attempts/1

Artifact

Subject: mkdocstrings_zig-0.0.7.tar.gz
SHA-256 checksum: f55dbb8398e9ad204525c3b70789f2e8ad789b8c515c27f292d426302663fe64 Verifying attestations

Release files / mkdocstrings_zig-0.0.7-py3-none-any.whl

Download URL	mkdocstrings_zig-0.0.7-py3-none-any.whl
Size	19.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`e446492829dfd6310071c8c7af0b8f3dca66d2e413b7168e29ab8de0a5732ea8`
BLAKE2b-256 checksum How to use checksums	`3616c3871fe5f16914d82add401e9ef1b4124f3b4fb1e0d9f7bee280cc188885`
Upload date	Jul 24, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.12.8`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/insolor/mkdocstrings-zig
Publishing commit: github.com/insolor/mkdocstrings-zig/tree/eb08156177ce897de3a349443cc56ece747c09eb

Workflow

Publishing configuration: github.com/insolor/mkdocstrings-zig/blob/eb08156177ce897de3a349443cc56ece747c09eb/.github/workflows/release.yml
Publishing logs: github.com/insolor/mkdocstrings-zig/actions/runs/16501218430/attempts/1

Artifact

Subject: mkdocstrings_zig-0.0.7-py3-none-any.whl
SHA-256 checksum: e446492829dfd6310071c8c7af0b8f3dca66d2e413b7168e29ab8de0a5732ea8 Verifying attestations