Skip to content

Commit 005d001

Browse files
committed
convert ipynb to qmd
1 parent e3a7457 commit 005d001

File tree

2 files changed

+45
-174
lines changed

2 files changed

+45
-174
lines changed

examples/vetiver/quartodoc.ipynb

Lines changed: 0 additions & 174 deletions
This file was deleted.

examples/vetiver/quartodoc.qmd

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
jupyter: python3
3+
---
4+
5+
```{python}
6+
from griffe.loader import GriffeLoader
7+
from griffe.docstrings.parsers import Parser
8+
9+
griffe = GriffeLoader(docstring_parser = Parser("numpy"))
10+
mod = griffe.load_module("vetiver") # no editable install
11+
12+
#f_obj = mod._modules_collection["vetiver.load_pkgs"]
13+
```
14+
15+
```{python}
16+
mod._modules_collection["vetiver.attach_pkgs.load_pkgs"] # full path
17+
```
18+
19+
```{python}
20+
from quartodoc import get_function, MdRenderer
21+
22+
# get function object ---
23+
f_obj = get_function("vetiver.attach_pkgs", "load_pkgs") # not attach.laod
24+
25+
26+
# render ---
27+
renderer = MdRenderer(header_level = 1)
28+
print(
29+
renderer.to_md(f_obj)
30+
)
31+
```
32+
33+
```{python}
34+
c_obj = mod._modules_collection["vetiver.server.VetiverAPI"]
35+
36+
print(
37+
renderer.to_md(c_obj)
38+
)
39+
```
40+
41+
```{python}
42+
renderer.to_md(c_obj.members["vetiver_post"]) # no -> none
43+
```
44+
45+

0 commit comments

Comments
 (0)