includepy 0.2

Include Python source code in Markdown files

Include Python source code in Markdown files

The includepy package provides a Markdown preprocessor that allows you to include the source code for a specific Python object (e.g., a function or class) when rendering Markdown content.

For example, to include the source code for the factorial function in example.py, add the following lines in a code block:

-->includepy<-- example.py
-->pyobject<-- factorial

The includepy preprocessor will turn this into the following:

def factorial(n: int) -> int:
    value = n  # (1)
    while n > 1:
        n -= 1
        value *= n
    return value

See the documentation for further details.