mkdocstrings-nim 0.1.1

A Nim handler for mkdocstrings

mkdocstrings-nim

A mkdocstrings handler for Nim.

Parses Nim source files using the Nim compiler's AST to extract module docstrings, procedure signatures, parameter types, return types, and {.raises.} pragma annotations. Renders the extracted documentation as HTML within MkDocs using the ::: module directive syntax.

Documentation

Installation

pip install mkdocstrings-nim

Requirements: Nim compiler must be installed and available in PATH.

Quick Start

1. Add to your mkdocs.yml:

plugins:
  - mkdocstrings:
      handlers:
        nim:
          paths: [src]

2. Use in your markdown:

# API Reference

::: mymodule

3. Build your docs:

mkdocs build

Configuration

Handler Options

Option	Default	Description
paths	["src"]	Search paths for Nim source files
docstring_style	"rst"	Docstring format: rst, google, numpy, epydoc, or auto
show_source	true	Show source line numbers
show_signature	true	Show full signatures
show_pragmas	true	Show pragma annotations

Docstring Format

Use RST-style docstrings in your Nim code:

proc greet*(name: string): string =
  ## Greet someone by name.
  ##
  ## :param name: The name to greet
  ## :returns: A greeting message
  result = "Hello, " & name & "!"

Development

git clone https://github.com/elijahr/mkdocstrings-nim
cd mkdocstrings-nim
pip install -e ".[dev]"
pytest

License

MIT