quartodoc 0.4.2

Generate API documentation with quarto.

quartodoc

Generate python API documentation for quarto.

Install

pip install quartodoc

Or for the latest changes:

python3 -m pip install -e git+https://github.com/machow/quartodoc.git#egg=quartodoc

Basic use

from quartodoc import get_function, MdRenderer

# get function object ---
f_obj = get_function("quartodoc", "get_function")

# render ---
renderer = MdRenderer(header_level = 1)
print(
    renderer.to_md(f_obj)
)

# get_function

`get_function(module: str, func_name: str, parser: str = 'numpy')`

Fetch a function.

## Parameters

| Name        | Type   | Description                | Default   |
|-------------|--------|----------------------------|-----------|
| `module`    | str    | A module name.             | required  |
| `func_name` | str    | A function name.           | required  |
| `parser`    | str    | A docstring parser to use. | `'numpy'` |

## Examples

```python
>>> get_function("quartodoc", "get_function")
<Function('get_function', ...
```

How it works

quartodoc consists of two pieces:

• collection: using the library griffe to statically collect information about functions and classes in a program.
• docstring parsing: also handled by griffe, which breaks it into a tree structure.
• docstring rendering: use plum-dispatch on methods like MdRenderer.to_md to decide how to visit and render each piece of the tree (e.g. the examples section, a parameter, etc..).

Here is a quick example of how you can grab a function from griffe and walk through it.

from griffe.loader import GriffeLoader
from griffe.docstrings.parsers import Parser

griffe = GriffeLoader(docstring_parser = Parser("numpy"))
mod = griffe.load_module("quartodoc")

f_obj = mod._modules_collection["quartodoc.get_function"]

f_obj.name

'get_function'

docstring = f_obj.docstring.parsed
docstring

[<griffe.docstrings.dataclasses.DocstringSectionText at 0x105a2c310>,
 <griffe.docstrings.dataclasses.DocstringSectionParameters at 0x10f7961f0>,
 <griffe.docstrings.dataclasses.DocstringSectionExamples at 0x10f7965b0>]

Note that quartodoc’s MdRenderer can be called on any part of the parsed docstring.

from quartodoc import MdRenderer

renderer = MdRenderer()

print(
    renderer.to_md(docstring[1])
)

| Name        | Type   | Description                | Default   |
|-------------|--------|----------------------------|-----------|
| `module`    | str    | A module name.             | required  |
| `func_name` | str    | A function name.           | required  |
| `parser`    | str    | A docstring parser to use. | `'numpy'` |