Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions examples/vetiver/quartodoc.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
jupyter: python3
---

```{python}
from griffe.loader import GriffeLoader
from griffe.docstrings.parsers import Parser

griffe = GriffeLoader(docstring_parser = Parser("numpy"))
mod = griffe.load_module("vetiver") # no editable install

#f_obj = mod._modules_collection["vetiver.load_pkgs"]
```

```{python}
mod._modules_collection["vetiver.attach_pkgs.load_pkgs"] # full path
```

```{python}
from quartodoc import get_function, MdRenderer

# get function object ---
f_obj = get_function("vetiver.attach_pkgs", "load_pkgs") # not attach.laod


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

```{python}
c_obj = mod._modules_collection["vetiver.server.VetiverAPI"]

print(
renderer.to_md(c_obj)
)
```

```{python}
renderer.to_md(c_obj.members["vetiver_post"]) # no -> none
```


5 changes: 4 additions & 1 deletion quartodoc.py
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,10 @@ def to_md(self, el: ds.DocstringSectionParameters):
def to_md(self, el: ds.DocstringParameter) -> Tuple[str]:
# TODO: if default is not, should return the word "required" (unescaped)
default = "required" if el.default is None else escape(el.default)
annotation = el.annotation.full if el.annotation else None
if isinstance(el.annotation, str):
annotation = el.annotation
else:
annotation = el.annotation.full if el.annotation else None
return (escape(el.name), annotation, el.description, default)

# examples ----
Expand Down