diff --git a/src/specklepy/docs/api.md b/src/specklepy/docs/api.md new file mode 100644 index 0000000..259e001 --- /dev/null +++ b/src/specklepy/docs/api.md @@ -0,0 +1,4 @@ +# API Reference + +::: specklepy +::: specklepy.api.client.SpeckleClient diff --git a/src/specklepy/docs/objects/base.md b/src/specklepy/docs/objects/base.md new file mode 100644 index 0000000..70c637c --- /dev/null +++ b/src/specklepy/docs/objects/base.md @@ -0,0 +1 @@ +::: specklepy.objects.base.Base diff --git a/src/specklepy/docs/objects/geometry/arc.md b/src/specklepy/docs/objects/geometry/arc.md new file mode 100644 index 0000000..9a13315 --- /dev/null +++ b/src/specklepy/docs/objects/geometry/arc.md @@ -0,0 +1 @@ +::: objects.geometry.arc.Arc diff --git a/src/specklepy/docs/reference.md b/src/specklepy/docs/reference.md deleted file mode 100644 index 5ce6e7b..0000000 --- a/src/specklepy/docs/reference.md +++ /dev/null @@ -1,6 +0,0 @@ -# API Reference - -::: specklepy -::: specklepy.api.client.SpeckleClient -::: specklepy.objects.geometry.arc -::: specklepy.objects.geometry.point diff --git a/src/specklepy/mkdocs.yml b/src/specklepy/mkdocs.yml index efd3534..9a56faa 100644 --- a/src/specklepy/mkdocs.yml +++ b/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 diff --git a/src/specklepy/objects/geometry/arc.py b/src/specklepy/objects/geometry/arc.py index f2d5008..64d1368 100644 --- a/src/specklepy/objects/geometry/arc.py +++ b/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