experiments

src/specklepy/docs/api.md

@@ -0,0 +1,4 @@
+# API Reference
+
+::: specklepy
+::: specklepy.api.client.SpeckleClient

src/specklepy/docs/objects/base.md

@@ -0,0 +1 @@
+::: specklepy.objects.base.Base

src/specklepy/docs/objects/geometry/arc.md

@@ -0,0 +1 @@
+::: objects.geometry.arc.Arc

src/specklepy/docs/reference.md

@@ -1,6 +0,0 @@
-# API Reference
-
-::: specklepy
-::: specklepy.api.client.SpeckleClient
-::: specklepy.objects.geometry.arc
-::: specklepy.objects.geometry.point

src/specklepy/mkdocs.yml

@@ -11,7 +11,7 @@ plugins:
           options:
             members_order: source
             separate_signature: true
-            filters: ["!^_"]
+            filters: ["!^_"] #Ignore _ prefixed properties
             docstring_options:
               ignore_init_summary: true
             merge_init_into_class: true
@@ -23,6 +23,6 @@ plugins:
               domains: [py, std]
           # selection:
           #   docstring_style: google # Ensures Google-style docstrings are parsed correctly
-          # rendering:
-          #   show_root_heading: true
-          #   show_source: true
+          rendering:
+            show_root_heading: true
+            show_source: true

src/specklepy/objects/geometry/arc.py

@@ -9,6 +9,18 @@ from specklepy.objects.interfaces import ICurve, IHasUnits
 
 @dataclass(kw_only=True)
 class Arc(Base, IHasUnits, ICurve, speckle_type="Objects.Geometry.Arc"):
+    """
+
+    attributes:
+     plane: asdfji;sfd
+     plane: asdfji;sfd
+     midPoint: ajosdfds
+     endPoint: ajosdfds
+
+    properties:
+      radius: asdfsadf
+    """
+
     plane: Plane
     startPoint: Point
     midPoint: Point