Merge pull request #218 from machow/feat-undoc-empty

Feat undoc empty

Author: machow

quartodoc/builder/blueprint.py

@@ -292,6 +292,9 @@ def _fetch_members(el: Auto, obj: dc.Object | dc.Alias):
         if not el.include_imports:
             options = {k: v for k, v in options.items() if not v.is_alias}
 
+        if not el.include_empty:
+            options = {k: v for k, v in options.items() if v.docstring is not None}
+
         # for modules, remove any Alias objects, since they were imported from
         # other places. Sphinx has a flag for this behavior, so may be good
         # to do something similar.

quartodoc/layout.py

@@ -198,6 +198,8 @@ class Auto(_Base):
         Whether to include members starting with "_"
     include_imports:
         Whether to include members that were imported from somewhere else.
+    include_empty:
+        Whether to include members with no docstring.
     include:
         (Not implemented). A list of members to include.
     exclude:
@@ -219,6 +221,7 @@ class Auto(_Base):
     members: Optional[list[str]] = None
     include_private: bool = False
     include_imports: bool = False
+    include_empty: bool = False
     include: Optional[str] = None
     exclude: Optional[str] = None
     dynamic: Union[None, bool, str] = None

quartodoc/tests/__snapshots__/test_renderers.ambr

@@ -23,9 +23,7 @@
   | --- | --- |
   | [SOME_ATTRIBUTE](#quartodoc.tests.example_class.C.SOME_ATTRIBUTE) | An attribute |
   | [some_property](#quartodoc.tests.example_class.C.some_property) | A property |
-  | [x](#quartodoc.tests.example_class.C.x) |  |
-  | [y](#quartodoc.tests.example_class.C.y) |  |
-  | [z](#quartodoc.tests.example_class.C.z) |  |
+  | [z](#quartodoc.tests.example_class.C.z) | A documented init attribute |
 
   ## Methods
 
@@ -64,9 +62,7 @@
   | --- | --- |
   | [SOME_ATTRIBUTE](#quartodoc.tests.example_class.C.SOME_ATTRIBUTE) | An attribute |
   | [some_property](#quartodoc.tests.example_class.C.some_property) | A property |
-  | [x](#quartodoc.tests.example_class.C.x) |  |
-  | [y](#quartodoc.tests.example_class.C.y) |  |
-  | [z](#quartodoc.tests.example_class.C.z) |  |
+  | [z](#quartodoc.tests.example_class.C.z) | A documented init attribute |
 
   ## Methods
 
@@ -116,12 +112,14 @@
 
   | Name | Description |
   | --- | --- |
-  | [AClass](#quartodoc.tests.example.AClass) |  |
+  | [AClass](#quartodoc.tests.example.AClass) | A class |
 
   ### AClass { #quartodoc.tests.example.AClass }
 
   `tests.example.AClass()`
 
+  A class
+  
   #### Attributes
 
   | Name | Description |
@@ -171,12 +169,14 @@
 
   | Name | Description |
   | --- | --- |
-  | [AClass](#quartodoc.tests.example.AClass) |  |
+  | [AClass](#quartodoc.tests.example.AClass) | A class |
 
   ## AClass { #quartodoc.tests.example.AClass }
 
   `tests.example.AClass()`
 
+  A class
+  
   ### Attributes
 
   | Name | Description |

quartodoc/tests/example.py

@@ -14,6 +14,8 @@ def a_func():
 
 
 class AClass:
+    """A class"""
+
     a_attr = 1
     """A class attribute"""
 

quartodoc/tests/example_class.py

@@ -20,6 +20,7 @@ def __init__(self, x: str, y: int):
         self.x = x
         self.y = y
         self.z: int = 1
+        """A documented init attribute"""
 
     def some_method(self):
         """A method"""