show-bases

Author: hamelsmu

quartodoc/builder/blueprint.py

@@ -332,6 +332,7 @@ def enter(self, el: Auto):
             children,
             flat=is_flat,
             signature_name=el.signature_name,
+            show_bases=el.show_bases
         )
 
     @staticmethod

quartodoc/layout.py

@@ -226,6 +226,7 @@ class AutoOptions(_Base):
     children: ChoicesChildren = ChoicesChildren.embedded
     package: Union[str, None, MISSING] = MISSING()
     member_options: Optional["AutoOptions"] = None
+    show_bases: bool = False
 
     # for tracking fields users manually specify
     # so we can tell them apart from defaults
@@ -274,6 +275,8 @@ class Auto(AutoOptions):
         If specified, object lookup will be relative to this path.
     member_options:
         Options to apply to members. These can include any of the options above.
+    show_bases:
+        Whether to show the base classes of a class.
 
 
     """
@@ -324,6 +327,8 @@ class Doc(_Docable):
         The loaded python object.
     anchor:
         An anchor named, used to locate this documentation on a [](`quartodoc.layout.Page`).
+    show_bases:
+        Whether to show the base classes of a class.
 
     See Also
     --------
@@ -335,6 +340,7 @@ class Doc(_Docable):
     name: str
     obj: Union[dc.Object, dc.Alias]
     anchor: str
+    show_bases: bool = False
     signature_name: SignatureOptions = "relative"
 
     class Config:
@@ -350,6 +356,7 @@ def from_griffe(
         anchor: str = None,
         flat: bool = False,
         signature_name: str = "relative",
+        show_bases: bool = False,
     ):
         if members is None:
             members = []
@@ -362,6 +369,7 @@ def from_griffe(
             "obj": obj,
             "anchor": anchor,
             "signature_name": signature_name,
+            "show_bases": show_bases
         }
 
         if kind == "function":

quartodoc/renderers/md_renderer.py

@@ -271,7 +271,9 @@ def render(self, el: layout.Doc):
     @dispatch
     def render(self, el: Union[layout.DocClass, layout.DocModule]):
         title = self.render_header(el)
-
+        bases=''
+        if el.show_bases and el.obj.is_class and el.obj.bases:
+            bases = f"\n\nBases: `{'`, '.join([x.source for x in el.obj.bases])}`"
         attr_docs = []
         meth_docs = []
         class_docs = []
@@ -340,7 +342,7 @@ def render(self, el: Union[layout.DocClass, layout.DocModule]):
         body = self.render(el.obj)
 
 
-        return "\n\n".join([title, *sig_part, body, *attr_docs, *class_docs, *meth_docs])
+        return "\n\n".join([title, *sig_part, bases, body, *attr_docs, *class_docs, *meth_docs])
 
     @dispatch
     def render(self, el: Union[layout.DocFunction, layout.DocAttribute]):