Metadata-Version: 2.1
Name: quartodoc
Version: 0.0.1
Summary: Generate API documentation with quarto.
Home-page: https://github.com/machow/quartodoc
Author: Michael Chow
Author-email: mc_al_github@fastmail.com
License: MIT
Keywords: template,packaging,documentation
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >3.8
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE


# quartodoc

Generate python API documentation for quarto.

## Install

## Basic use

``` python
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.

    | 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'` |

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

\`\`\`
