docs: update griffe imports in examples to v1 paths

Author: machow

case_studies/parsing.qmd

@@ -55,12 +55,12 @@ res["objects"][0]["children"]["some_package"]["children"]
 ## Running griffe
 
 ```{python}
-from griffe.loader import GriffeLoader
-from griffe.docstrings.parsers import Parser, parse
+from griffe import GriffeLoader
+from griffe import Parser, parse
 
-griffe = GriffeLoader()
+loader = GriffeLoader()
 
-sb2 = griffe.load_module("some_package")
+sb2 = loader.load("some_package")
 
 parse(sb2.functions["some_function"].docstring, Parser.numpy)
 ```

docs/get-started/basic-content.qmd

@@ -66,14 +66,14 @@ By default, all attributes and functions (including methods on a class) are pres
 There are four styles for presenting child members:
 
 ```{python}
-#| echo: false
-#| output: asis
+# | echo: false
+# | output: asis
 
-# print out the attributes table of ChoicesChildren 
+# print out the attributes table of ChoicesChildren
 # this is overkill, but maybe a nice case of dogfooding
 from quartodoc import get_object, MdRenderer
 from quartodoc.builder.utils import extract_type
-from griffe.docstrings.dataclasses import DocstringSectionAttributes
+from griffe import DocstringSectionAttributes
 
 renderer = MdRenderer()
 choices = get_object("quartodoc.layout.ChoicesChildren")
@@ -420,12 +420,12 @@ Below is a summary of all the options that can be applied to individual content
 
 
 ```{python}
-#| echo: false
-#| output: asis
+# | echo: false
+# | output: asis
 
 from quartodoc import get_object, MdRenderer, Auto
 from quartodoc.builder.utils import extract_type
-from griffe.docstrings.dataclasses import DocstringSectionAttributes
+from griffe import DocstringSectionAttributes
 
 renderer = MdRenderer()
 choices = get_object("quartodoc.Auto")

docs/get-started/dev-renderers.qmd

@@ -57,19 +57,20 @@ types of objects.
 ```{python}
 from plum import dispatch
 
-import griffe.dataclasses as dc
-import griffe.docstrings.dataclasses as ds
+from griffe import Alias, Object, Docstring
 
 
 @dispatch
 def render(el: object):
     print(f"Default rendering: {type(el)}")
 
+
 @dispatch
-def render(el: dc.Alias):
+def render(el: Alias):
     print("Alias rendering")
     render(el.parameters)
 
+
 @dispatch
 def render(el: list):
     print("List rendering")
@@ -85,8 +86,7 @@ quartodoc uses tree visitors to render parsed docstrings to formats like markdow
 Tree visitors define how each type of object in the parse tree should be handled.
 
 ```{python}
-import griffe.dataclasses as dc
-import griffe.docstrings.dataclasses as ds
+from griffe import Alias, Object, Docstring
 
 from quartodoc import get_object
 from plum import dispatch
@@ -102,17 +102,17 @@ class SomeRenderer:
         raise NotImplementedError(f"Unsupported type: {type(el)}")
 
     @dispatch
-    def render(self, el: Union[dc.Alias, dc.Object]):
+    def render(self, el: Union[Alias, Object]):
         header = "#" * self.header_level
         str_header = f"{header} {el.name}"
         str_params = f"N PARAMETERS: {len(el.parameters)}"
         str_sections = "SECTIONS: " + self.render(el.docstring)
-        
+
         # return something pretty
         return "\n".join([str_header, str_params, str_sections])
 
     @dispatch
-    def render(self, el: dc.Docstring):
+    def render(self, el: Docstring):
         return f"A docstring with {len(el.parsed)} pieces"
 
 

docs/get-started/extending.qmd

@@ -40,7 +40,7 @@ Then, create the file `reference/index.qmd` to have the form:
 Some custom content.
 
 
-{{< include /reference/_api_index.qmd >}}
+{{{< include /reference/_api_index.qmd >}}}
 
 
 More content stuff.