diff --git a/docs/kcl/angleToMatchLengthX.md b/docs/kcl/angleToMatchLengthX.md index 1c743f950..042d8dd19 100644 --- a/docs/kcl/angleToMatchLengthX.md +++ b/docs/kcl/angleToMatchLengthX.md @@ -17,9 +17,9 @@ angleToMatchLengthX(tag: TagIdentifier, to: number, sketch_group: SketchGroup) - | Name | Type | Description | Required | |----------|------|-------------|----------| -| `tag` | [`TagIdentifier`](kcl/types#tag-identifier) | | Yes | +| `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | | Yes | | `to` | `number` | | Yes | -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | ### Returns diff --git a/docs/kcl/angleToMatchLengthY.md b/docs/kcl/angleToMatchLengthY.md index 7d4291a77..4f05c5daf 100644 --- a/docs/kcl/angleToMatchLengthY.md +++ b/docs/kcl/angleToMatchLengthY.md @@ -17,9 +17,9 @@ angleToMatchLengthY(tag: TagIdentifier, to: number, sketch_group: SketchGroup) - | Name | Type | Description | Required | |----------|------|-------------|----------| -| `tag` | [`TagIdentifier`](kcl/types#tag-identifier) | | Yes | +| `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | | Yes | | `to` | `number` | | Yes | -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | ### Returns diff --git a/docs/kcl/angledLine.md b/docs/kcl/angledLine.md index 450a49aad..b80d4fc2d 100644 --- a/docs/kcl/angledLine.md +++ b/docs/kcl/angledLine.md @@ -17,13 +17,13 @@ angledLine(data: AngledLineData, sketch_group: SketchGroup, tag?: TagDeclarator) | Name | Type | Description | Required | |----------|------|-------------|----------| -| `data` | [`AngledLineData`](kcl/types/AngledLineData) | Data to draw an angled line. | Yes | -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | -| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | +| `data` | [`AngledLineData`](/docs/kcl/types/AngledLineData) | Data to draw an angled line. | Yes | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No | ### Returns -[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. +[`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths. ### Examples diff --git a/docs/kcl/angledLineOfXLength.md b/docs/kcl/angledLineOfXLength.md index 371bcb0bf..745b37dd3 100644 --- a/docs/kcl/angledLineOfXLength.md +++ b/docs/kcl/angledLineOfXLength.md @@ -17,13 +17,13 @@ angledLineOfXLength(data: AngledLineData, sketch_group: SketchGroup, tag?: TagDe | Name | Type | Description | Required | |----------|------|-------------|----------| -| `data` | [`AngledLineData`](kcl/types/AngledLineData) | Data to draw an angled line. | Yes | -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | -| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | +| `data` | [`AngledLineData`](/docs/kcl/types/AngledLineData) | Data to draw an angled line. | Yes | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No | ### Returns -[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. +[`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths. ### Examples diff --git a/docs/kcl/angledLineOfYLength.md b/docs/kcl/angledLineOfYLength.md index dc68f4f3b..6a574ea89 100644 --- a/docs/kcl/angledLineOfYLength.md +++ b/docs/kcl/angledLineOfYLength.md @@ -17,13 +17,13 @@ angledLineOfYLength(data: AngledLineData, sketch_group: SketchGroup, tag?: TagDe | Name | Type | Description | Required | |----------|------|-------------|----------| -| `data` | [`AngledLineData`](kcl/types/AngledLineData) | Data to draw an angled line. | Yes | -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | -| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | +| `data` | [`AngledLineData`](/docs/kcl/types/AngledLineData) | Data to draw an angled line. | Yes | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No | ### Returns -[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. +[`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths. ### Examples diff --git a/docs/kcl/angledLineThatIntersects.md b/docs/kcl/angledLineThatIntersects.md index 169dda592..28fd21de7 100644 --- a/docs/kcl/angledLineThatIntersects.md +++ b/docs/kcl/angledLineThatIntersects.md @@ -17,13 +17,13 @@ angledLineThatIntersects(data: AngledLineThatIntersectsData, sketch_group: Sketc | Name | Type | Description | Required | |----------|------|-------------|----------| -| `data` | [`AngledLineThatIntersectsData`](kcl/types/AngledLineThatIntersectsData) | Data for drawing an angled line that intersects with a given line. | Yes | -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | -| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | +| `data` | [`AngledLineThatIntersectsData`](/docs/kcl/types/AngledLineThatIntersectsData) | Data for drawing an angled line that intersects with a given line. | Yes | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No | ### Returns -[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. +[`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths. ### Examples diff --git a/docs/kcl/angledLineToX.md b/docs/kcl/angledLineToX.md index fdb11df37..b66ccd937 100644 --- a/docs/kcl/angledLineToX.md +++ b/docs/kcl/angledLineToX.md @@ -17,13 +17,13 @@ angledLineToX(data: AngledLineToData, sketch_group: SketchGroup, tag?: TagDeclar | Name | Type | Description | Required | |----------|------|-------------|----------| -| `data` | [`AngledLineToData`](kcl/types/AngledLineToData) | Data to draw an angled line to a point. | Yes | -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | -| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | +| `data` | [`AngledLineToData`](/docs/kcl/types/AngledLineToData) | Data to draw an angled line to a point. | Yes | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No | ### Returns -[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. +[`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths. ### Examples diff --git a/docs/kcl/angledLineToY.md b/docs/kcl/angledLineToY.md index b6543ccbb..55a03ee51 100644 --- a/docs/kcl/angledLineToY.md +++ b/docs/kcl/angledLineToY.md @@ -17,13 +17,13 @@ angledLineToY(data: AngledLineToData, sketch_group: SketchGroup, tag?: TagDeclar | Name | Type | Description | Required | |----------|------|-------------|----------| -| `data` | [`AngledLineToData`](kcl/types/AngledLineToData) | Data to draw an angled line to a point. | Yes | -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | -| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | +| `data` | [`AngledLineToData`](/docs/kcl/types/AngledLineToData) | Data to draw an angled line to a point. | Yes | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No | ### Returns -[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. +[`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths. ### Examples diff --git a/docs/kcl/arc.md b/docs/kcl/arc.md index ea5d404d9..897fad602 100644 --- a/docs/kcl/arc.md +++ b/docs/kcl/arc.md @@ -19,13 +19,13 @@ arc(data: ArcData, sketch_group: SketchGroup, tag?: TagDeclarator) -> SketchGrou | Name | Type | Description | Required | |----------|------|-------------|----------| -| `data` | [`ArcData`](kcl/types/ArcData) | Data to draw an arc. | Yes | -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | -| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | +| `data` | [`ArcData`](/docs/kcl/types/ArcData) | Data to draw an arc. | Yes | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No | ### Returns -[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. +[`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths. ### Examples diff --git a/docs/kcl/arrayReduce.md b/docs/kcl/arrayReduce.md index 9e7cd81c9..8b986d7fa 100644 --- a/docs/kcl/arrayReduce.md +++ b/docs/kcl/arrayReduce.md @@ -17,13 +17,13 @@ arrayReduce(array: [u64], start: SketchGroup, reduce_fn: FunctionParam) -> Sketc | Name | Type | Description | Required | |----------|------|-------------|----------| -| `array` | [`[u64]`](kcl/types/[u64]) | | Yes | -| `start` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `array` | [`[u64]`](/docs/kcl/types/[u64]) | | Yes | +| `start` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | | `reduce_fn` | `FunctionParam` | | Yes | ### Returns -[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. +[`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths. ### Examples diff --git a/docs/kcl/bezierCurve.md b/docs/kcl/bezierCurve.md index b87c2295b..f76b24d0f 100644 --- a/docs/kcl/bezierCurve.md +++ b/docs/kcl/bezierCurve.md @@ -17,13 +17,13 @@ bezierCurve(data: BezierData, sketch_group: SketchGroup, tag?: TagDeclarator) -> | Name | Type | Description | Required | |----------|------|-------------|----------| -| `data` | [`BezierData`](kcl/types/BezierData) | Data to draw a bezier curve. | Yes | -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | -| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | +| `data` | [`BezierData`](/docs/kcl/types/BezierData) | Data to draw a bezier curve. | Yes | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No | ### Returns -[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. +[`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths. ### Examples diff --git a/docs/kcl/chamfer.md b/docs/kcl/chamfer.md index e96cedf27..b8face660 100644 --- a/docs/kcl/chamfer.md +++ b/docs/kcl/chamfer.md @@ -17,13 +17,13 @@ chamfer(data: ChamferData, extrude_group: ExtrudeGroup, tag?: TagDeclarator) -> | Name | Type | Description | Required | |----------|------|-------------|----------| -| `data` | [`ChamferData`](kcl/types/ChamferData) | Data for chamfers. | Yes | -| `extrude_group` | [`ExtrudeGroup`](kcl/types/ExtrudeGroup) | An extrude group is a collection of extrude surfaces. | Yes | -| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | +| `data` | [`ChamferData`](/docs/kcl/types/ChamferData) | Data for chamfers. | Yes | +| `extrude_group` | [`ExtrudeGroup`](/docs/kcl/types/ExtrudeGroup) | An extrude group is a collection of extrude surfaces. | Yes | +| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No | ### Returns -[`ExtrudeGroup`](kcl/types/ExtrudeGroup) - An extrude group is a collection of extrude surfaces. +[`ExtrudeGroup`](/docs/kcl/types/ExtrudeGroup) - An extrude group is a collection of extrude surfaces. ### Examples diff --git a/docs/kcl/circle.md b/docs/kcl/circle.md index d952c8846..e45c8e6ac 100644 --- a/docs/kcl/circle.md +++ b/docs/kcl/circle.md @@ -17,13 +17,13 @@ circle(data: CircleData, sketch_surface_or_group: SketchSurfaceOrGroup, tag?: Ta | Name | Type | Description | Required | |----------|------|-------------|----------| -| `data` | [`CircleData`](kcl/types/CircleData) | Data for drawing an circle | Yes | -| `sketch_surface_or_group` | [`SketchSurfaceOrGroup`](kcl/types/SketchSurfaceOrGroup) | A sketch surface or a sketch group. | Yes | -| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | +| `data` | [`CircleData`](/docs/kcl/types/CircleData) | Data for drawing an circle | Yes | +| `sketch_surface_or_group` | [`SketchSurfaceOrGroup`](/docs/kcl/types/SketchSurfaceOrGroup) | A sketch surface or a sketch group. | Yes | +| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No | ### Returns -[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. +[`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths. ### Examples diff --git a/docs/kcl/close.md b/docs/kcl/close.md index 7f57c37ed..d9898ec65 100644 --- a/docs/kcl/close.md +++ b/docs/kcl/close.md @@ -17,12 +17,12 @@ close(sketch_group: SketchGroup, tag?: TagDeclarator) -> SketchGroup | Name | Type | Description | Required | |----------|------|-------------|----------| -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | -| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No | ### Returns -[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. +[`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths. ### Examples diff --git a/docs/kcl/extrude.md b/docs/kcl/extrude.md index 34aae63fd..0b0f1e1b9 100644 --- a/docs/kcl/extrude.md +++ b/docs/kcl/extrude.md @@ -18,11 +18,11 @@ extrude(length: number, sketch_group_set: SketchGroupSet) -> ExtrudeGroupSet | Name | Type | Description | Required | |----------|------|-------------|----------| | `length` | `number` | | Yes | -| `sketch_group_set` | [`SketchGroupSet`](kcl/types/SketchGroupSet) | A sketch group or a group of sketch groups. | Yes | +| `sketch_group_set` | [`SketchGroupSet`](/docs/kcl/types/SketchGroupSet) | A sketch group or a group of sketch groups. | Yes | ### Returns -[`ExtrudeGroupSet`](kcl/types/ExtrudeGroupSet) - A extrude group or a group of extrude groups. +[`ExtrudeGroupSet`](/docs/kcl/types/ExtrudeGroupSet) - A extrude group or a group of extrude groups. ### Examples diff --git a/docs/kcl/fillet.md b/docs/kcl/fillet.md index 9e5cab4f4..407247ec2 100644 --- a/docs/kcl/fillet.md +++ b/docs/kcl/fillet.md @@ -17,13 +17,13 @@ fillet(data: FilletData, extrude_group: ExtrudeGroup, tag?: TagDeclarator) -> Ex | Name | Type | Description | Required | |----------|------|-------------|----------| -| `data` | [`FilletData`](kcl/types/FilletData) | Data for fillets. | Yes | -| `extrude_group` | [`ExtrudeGroup`](kcl/types/ExtrudeGroup) | An extrude group is a collection of extrude surfaces. | Yes | -| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | +| `data` | [`FilletData`](/docs/kcl/types/FilletData) | Data for fillets. | Yes | +| `extrude_group` | [`ExtrudeGroup`](/docs/kcl/types/ExtrudeGroup) | An extrude group is a collection of extrude surfaces. | Yes | +| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No | ### Returns -[`ExtrudeGroup`](kcl/types/ExtrudeGroup) - An extrude group is a collection of extrude surfaces. +[`ExtrudeGroup`](/docs/kcl/types/ExtrudeGroup) - An extrude group is a collection of extrude surfaces. ### Examples diff --git a/docs/kcl/getNextAdjacentEdge.md b/docs/kcl/getNextAdjacentEdge.md index 47dbdf36a..55b58395b 100644 --- a/docs/kcl/getNextAdjacentEdge.md +++ b/docs/kcl/getNextAdjacentEdge.md @@ -17,7 +17,7 @@ getNextAdjacentEdge(tag: TagIdentifier) -> Uuid | Name | Type | Description | Required | |----------|------|-------------|----------| -| `tag` | [`TagIdentifier`](kcl/types#tag-identifier) | | Yes | +| `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | | Yes | ### Returns diff --git a/docs/kcl/getOppositeEdge.md b/docs/kcl/getOppositeEdge.md index 2eb796c6d..3e2d906ba 100644 --- a/docs/kcl/getOppositeEdge.md +++ b/docs/kcl/getOppositeEdge.md @@ -17,7 +17,7 @@ getOppositeEdge(tag: TagIdentifier) -> Uuid | Name | Type | Description | Required | |----------|------|-------------|----------| -| `tag` | [`TagIdentifier`](kcl/types#tag-identifier) | | Yes | +| `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | | Yes | ### Returns diff --git a/docs/kcl/getPreviousAdjacentEdge.md b/docs/kcl/getPreviousAdjacentEdge.md index ddd9319f5..60859f697 100644 --- a/docs/kcl/getPreviousAdjacentEdge.md +++ b/docs/kcl/getPreviousAdjacentEdge.md @@ -17,7 +17,7 @@ getPreviousAdjacentEdge(tag: TagIdentifier) -> Uuid | Name | Type | Description | Required | |----------|------|-------------|----------| -| `tag` | [`TagIdentifier`](kcl/types#tag-identifier) | | Yes | +| `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | | Yes | ### Returns diff --git a/docs/kcl/helix.md b/docs/kcl/helix.md index f1f19cf93..5eeb154ee 100644 --- a/docs/kcl/helix.md +++ b/docs/kcl/helix.md @@ -17,12 +17,12 @@ helix(data: HelixData, extrude_group: ExtrudeGroup) -> ExtrudeGroup | Name | Type | Description | Required | |----------|------|-------------|----------| -| `data` | [`HelixData`](kcl/types/HelixData) | Data for helices. | Yes | -| `extrude_group` | [`ExtrudeGroup`](kcl/types/ExtrudeGroup) | An extrude group is a collection of extrude surfaces. | Yes | +| `data` | [`HelixData`](/docs/kcl/types/HelixData) | Data for helices. | Yes | +| `extrude_group` | [`ExtrudeGroup`](/docs/kcl/types/ExtrudeGroup) | An extrude group is a collection of extrude surfaces. | Yes | ### Returns -[`ExtrudeGroup`](kcl/types/ExtrudeGroup) - An extrude group is a collection of extrude surfaces. +[`ExtrudeGroup`](/docs/kcl/types/ExtrudeGroup) - An extrude group is a collection of extrude surfaces. ### Examples diff --git a/docs/kcl/hole.md b/docs/kcl/hole.md index b2aa5fcc6..e62533dc4 100644 --- a/docs/kcl/hole.md +++ b/docs/kcl/hole.md @@ -17,12 +17,12 @@ hole(hole_sketch_group: SketchGroupSet, sketch_group: SketchGroup) -> SketchGrou | Name | Type | Description | Required | |----------|------|-------------|----------| -| `hole_sketch_group` | [`SketchGroupSet`](kcl/types/SketchGroupSet) | A sketch group or a group of sketch groups. | Yes | -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `hole_sketch_group` | [`SketchGroupSet`](/docs/kcl/types/SketchGroupSet) | A sketch group or a group of sketch groups. | Yes | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | ### Returns -[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. +[`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths. ### Examples diff --git a/docs/kcl/hollow.md b/docs/kcl/hollow.md index 8dfe6d62a..b642f85c5 100644 --- a/docs/kcl/hollow.md +++ b/docs/kcl/hollow.md @@ -18,11 +18,11 @@ hollow(thickness: number, extrude_group: ExtrudeGroup) -> ExtrudeGroup | Name | Type | Description | Required | |----------|------|-------------|----------| | `thickness` | `number` | | Yes | -| `extrude_group` | [`ExtrudeGroup`](kcl/types/ExtrudeGroup) | An extrude group is a collection of extrude surfaces. | Yes | +| `extrude_group` | [`ExtrudeGroup`](/docs/kcl/types/ExtrudeGroup) | An extrude group is a collection of extrude surfaces. | Yes | ### Returns -[`ExtrudeGroup`](kcl/types/ExtrudeGroup) - An extrude group is a collection of extrude surfaces. +[`ExtrudeGroup`](/docs/kcl/types/ExtrudeGroup) - An extrude group is a collection of extrude surfaces. ### Examples diff --git a/docs/kcl/import.md b/docs/kcl/import.md index 5b2914752..897a52b1c 100644 --- a/docs/kcl/import.md +++ b/docs/kcl/import.md @@ -19,11 +19,11 @@ import(file_path: String, options?: ImportFormat) -> ImportedGeometry | Name | Type | Description | Required | |----------|------|-------------|----------| | `file_path` | `String` | | Yes | -| `options` | [`ImportFormat`](kcl/types/ImportFormat) | Import format specifier | No | +| `options` | [`ImportFormat`](/docs/kcl/types/ImportFormat) | Import format specifier | No | ### Returns -[`ImportedGeometry`](kcl/types/ImportedGeometry) - Data for an imported geometry. +[`ImportedGeometry`](/docs/kcl/types/ImportedGeometry) - Data for an imported geometry. ### Examples diff --git a/docs/kcl/lastSegX.md b/docs/kcl/lastSegX.md index ee3af5427..33e221634 100644 --- a/docs/kcl/lastSegX.md +++ b/docs/kcl/lastSegX.md @@ -17,7 +17,7 @@ lastSegX(sketch_group: SketchGroup) -> number | Name | Type | Description | Required | |----------|------|-------------|----------| -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | ### Returns diff --git a/docs/kcl/lastSegY.md b/docs/kcl/lastSegY.md index 5c993109b..636c19d7b 100644 --- a/docs/kcl/lastSegY.md +++ b/docs/kcl/lastSegY.md @@ -17,7 +17,7 @@ lastSegY(sketch_group: SketchGroup) -> number | Name | Type | Description | Required | |----------|------|-------------|----------| -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | ### Returns diff --git a/docs/kcl/line.md b/docs/kcl/line.md index bb8d51c9b..238693402 100644 --- a/docs/kcl/line.md +++ b/docs/kcl/line.md @@ -17,13 +17,13 @@ line(delta: [number], sketch_group: SketchGroup, tag?: TagDeclarator) -> SketchG | Name | Type | Description | Required | |----------|------|-------------|----------| -| `delta` | [`[number]`](kcl/types/[number]) | | Yes | -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | -| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | +| `delta` | [`[number]`](/docs/kcl/types/[number]) | | Yes | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No | ### Returns -[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. +[`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths. ### Examples diff --git a/docs/kcl/lineTo.md b/docs/kcl/lineTo.md index 44599765f..40ac6341b 100644 --- a/docs/kcl/lineTo.md +++ b/docs/kcl/lineTo.md @@ -17,13 +17,13 @@ lineTo(to: [number], sketch_group: SketchGroup, tag?: TagDeclarator) -> SketchGr | Name | Type | Description | Required | |----------|------|-------------|----------| -| `to` | [`[number]`](kcl/types/[number]) | | Yes | -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | -| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | +| `to` | [`[number]`](/docs/kcl/types/[number]) | | Yes | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No | ### Returns -[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. +[`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths. ### Examples diff --git a/docs/kcl/loft.md b/docs/kcl/loft.md index f98e1b9a9..fa08e1b23 100644 --- a/docs/kcl/loft.md +++ b/docs/kcl/loft.md @@ -17,12 +17,12 @@ loft(sketch_groups: [SketchGroup], data?: LoftData) -> ExtrudeGroup | Name | Type | Description | Required | |----------|------|-------------|----------| -| `sketch_groups` | [`[SketchGroup]`](kcl/types/[SketchGroup]) | | Yes | -| `data` | [`LoftData`](kcl/types/LoftData) | Data for a loft. | No | +| `sketch_groups` | [`[SketchGroup]`](/docs/kcl/types/[SketchGroup]) | | Yes | +| `data` | [`LoftData`](/docs/kcl/types/LoftData) | Data for a loft. | No | ### Returns -[`ExtrudeGroup`](kcl/types/ExtrudeGroup) - An extrude group is a collection of extrude surfaces. +[`ExtrudeGroup`](/docs/kcl/types/ExtrudeGroup) - An extrude group is a collection of extrude surfaces. ### Examples diff --git a/docs/kcl/max.md b/docs/kcl/max.md index 4a9020162..e2d39491c 100644 --- a/docs/kcl/max.md +++ b/docs/kcl/max.md @@ -21,7 +21,7 @@ max(args: [number]) -> number | Name | Type | Description | Required | |----------|------|-------------|----------| -| `args` | [`[number]`](kcl/types/[number]) | | Yes | +| `args` | [`[number]`](/docs/kcl/types/[number]) | | Yes | ### Returns diff --git a/docs/kcl/min.md b/docs/kcl/min.md index ab3e5bd7c..2778a44dc 100644 --- a/docs/kcl/min.md +++ b/docs/kcl/min.md @@ -21,7 +21,7 @@ min(args: [number]) -> number | Name | Type | Description | Required | |----------|------|-------------|----------| -| `args` | [`[number]`](kcl/types/[number]) | | Yes | +| `args` | [`[number]`](/docs/kcl/types/[number]) | | Yes | ### Returns diff --git a/docs/kcl/mirror2d.md b/docs/kcl/mirror2d.md index 89768ebe8..82684ba3f 100644 --- a/docs/kcl/mirror2d.md +++ b/docs/kcl/mirror2d.md @@ -18,12 +18,12 @@ mirror2d(data: Mirror2dData, sketch_group_set: SketchGroupSet) -> [SketchGroup] | Name | Type | Description | Required | |----------|------|-------------|----------| -| `data` | [`Mirror2dData`](kcl/types/Mirror2dData) | Data for a mirror. | Yes | -| `sketch_group_set` | [`SketchGroupSet`](kcl/types/SketchGroupSet) | A sketch group or a group of sketch groups. | Yes | +| `data` | [`Mirror2dData`](/docs/kcl/types/Mirror2dData) | Data for a mirror. | Yes | +| `sketch_group_set` | [`SketchGroupSet`](/docs/kcl/types/SketchGroupSet) | A sketch group or a group of sketch groups. | Yes | ### Returns -[`[SketchGroup]`](kcl/types/[SketchGroup]) +[`[SketchGroup]`](/docs/kcl/types/[SketchGroup]) ### Examples diff --git a/docs/kcl/offsetPlane.md b/docs/kcl/offsetPlane.md index 9cf9d0db7..fc7d61137 100644 --- a/docs/kcl/offsetPlane.md +++ b/docs/kcl/offsetPlane.md @@ -17,12 +17,12 @@ offsetPlane(std_plane: StandardPlane, offset: number) -> PlaneData | Name | Type | Description | Required | |----------|------|-------------|----------| -| `std_plane` | [`StandardPlane`](kcl/types/StandardPlane) | One of the standard planes. | Yes | +| `std_plane` | [`StandardPlane`](/docs/kcl/types/StandardPlane) | One of the standard planes. | Yes | | `offset` | `number` | | Yes | ### Returns -[`PlaneData`](kcl/types/PlaneData) - Data for a plane. +[`PlaneData`](/docs/kcl/types/PlaneData) - Data for a plane. ### Examples diff --git a/docs/kcl/patternCircular2d.md b/docs/kcl/patternCircular2d.md index 0634dae8f..b29eebf38 100644 --- a/docs/kcl/patternCircular2d.md +++ b/docs/kcl/patternCircular2d.md @@ -17,12 +17,12 @@ patternCircular2d(data: CircularPattern2dData, sketch_group_set: SketchGroupSet) | Name | Type | Description | Required | |----------|------|-------------|----------| -| `data` | [`CircularPattern2dData`](kcl/types/CircularPattern2dData) | Data for a circular pattern on a 2D sketch. | Yes | -| `sketch_group_set` | [`SketchGroupSet`](kcl/types/SketchGroupSet) | A sketch group or a group of sketch groups. | Yes | +| `data` | [`CircularPattern2dData`](/docs/kcl/types/CircularPattern2dData) | Data for a circular pattern on a 2D sketch. | Yes | +| `sketch_group_set` | [`SketchGroupSet`](/docs/kcl/types/SketchGroupSet) | A sketch group or a group of sketch groups. | Yes | ### Returns -[`[SketchGroup]`](kcl/types/[SketchGroup]) +[`[SketchGroup]`](/docs/kcl/types/[SketchGroup]) ### Examples diff --git a/docs/kcl/patternCircular3d.md b/docs/kcl/patternCircular3d.md index 62558b33b..68ad943e9 100644 --- a/docs/kcl/patternCircular3d.md +++ b/docs/kcl/patternCircular3d.md @@ -17,12 +17,12 @@ patternCircular3d(data: CircularPattern3dData, extrude_group_set: ExtrudeGroupSe | Name | Type | Description | Required | |----------|------|-------------|----------| -| `data` | [`CircularPattern3dData`](kcl/types/CircularPattern3dData) | Data for a circular pattern on a 3D model. | Yes | -| `extrude_group_set` | [`ExtrudeGroupSet`](kcl/types/ExtrudeGroupSet) | A extrude group or a group of extrude groups. | Yes | +| `data` | [`CircularPattern3dData`](/docs/kcl/types/CircularPattern3dData) | Data for a circular pattern on a 3D model. | Yes | +| `extrude_group_set` | [`ExtrudeGroupSet`](/docs/kcl/types/ExtrudeGroupSet) | A extrude group or a group of extrude groups. | Yes | ### Returns -[`[ExtrudeGroup]`](kcl/types/[ExtrudeGroup]) +[`[ExtrudeGroup]`](/docs/kcl/types/[ExtrudeGroup]) ### Examples diff --git a/docs/kcl/patternLinear2d.md b/docs/kcl/patternLinear2d.md index 0c108ea8d..7769f78ec 100644 --- a/docs/kcl/patternLinear2d.md +++ b/docs/kcl/patternLinear2d.md @@ -17,12 +17,12 @@ patternLinear2d(data: LinearPattern2dData, sketch_group_set: SketchGroupSet) -> | Name | Type | Description | Required | |----------|------|-------------|----------| -| `data` | [`LinearPattern2dData`](kcl/types/LinearPattern2dData) | Data for a linear pattern on a 2D sketch. | Yes | -| `sketch_group_set` | [`SketchGroupSet`](kcl/types/SketchGroupSet) | A sketch group or a group of sketch groups. | Yes | +| `data` | [`LinearPattern2dData`](/docs/kcl/types/LinearPattern2dData) | Data for a linear pattern on a 2D sketch. | Yes | +| `sketch_group_set` | [`SketchGroupSet`](/docs/kcl/types/SketchGroupSet) | A sketch group or a group of sketch groups. | Yes | ### Returns -[`[SketchGroup]`](kcl/types/[SketchGroup]) +[`[SketchGroup]`](/docs/kcl/types/[SketchGroup]) ### Examples diff --git a/docs/kcl/patternLinear3d.md b/docs/kcl/patternLinear3d.md index 0bc416c60..586ae3222 100644 --- a/docs/kcl/patternLinear3d.md +++ b/docs/kcl/patternLinear3d.md @@ -17,12 +17,12 @@ patternLinear3d(data: LinearPattern3dData, extrude_group_set: ExtrudeGroupSet) - | Name | Type | Description | Required | |----------|------|-------------|----------| -| `data` | [`LinearPattern3dData`](kcl/types/LinearPattern3dData) | Data for a linear pattern on a 3D model. | Yes | -| `extrude_group_set` | [`ExtrudeGroupSet`](kcl/types/ExtrudeGroupSet) | A extrude group or a group of extrude groups. | Yes | +| `data` | [`LinearPattern3dData`](/docs/kcl/types/LinearPattern3dData) | Data for a linear pattern on a 3D model. | Yes | +| `extrude_group_set` | [`ExtrudeGroupSet`](/docs/kcl/types/ExtrudeGroupSet) | A extrude group or a group of extrude groups. | Yes | ### Returns -[`[ExtrudeGroup]`](kcl/types/[ExtrudeGroup]) +[`[ExtrudeGroup]`](/docs/kcl/types/[ExtrudeGroup]) ### Examples diff --git a/docs/kcl/patternTransform.md b/docs/kcl/patternTransform.md index 267a835d8..5a66bf435 100644 --- a/docs/kcl/patternTransform.md +++ b/docs/kcl/patternTransform.md @@ -21,11 +21,11 @@ patternTransform(total_instances: u32, transform_function: FunctionParam, extrud |----------|------|-------------|----------| | `total_instances` | `u32` | | Yes | | `transform_function` | `FunctionParam` | | Yes | -| `extrude_group_set` | [`ExtrudeGroupSet`](kcl/types/ExtrudeGroupSet) | A extrude group or a group of extrude groups. | Yes | +| `extrude_group_set` | [`ExtrudeGroupSet`](/docs/kcl/types/ExtrudeGroupSet) | A extrude group or a group of extrude groups. | Yes | ### Returns -[`[ExtrudeGroup]`](kcl/types/[ExtrudeGroup]) +[`[ExtrudeGroup]`](/docs/kcl/types/[ExtrudeGroup]) ### Examples diff --git a/docs/kcl/polar.md b/docs/kcl/polar.md index 45fb0fbf3..f15d5c7e1 100644 --- a/docs/kcl/polar.md +++ b/docs/kcl/polar.md @@ -17,11 +17,11 @@ polar(data: PolarCoordsData) -> [number] | Name | Type | Description | Required | |----------|------|-------------|----------| -| `data` | [`PolarCoordsData`](kcl/types/PolarCoordsData) | Data for polar coordinates. | Yes | +| `data` | [`PolarCoordsData`](/docs/kcl/types/PolarCoordsData) | Data for polar coordinates. | Yes | ### Returns -[`[number]`](kcl/types/[number]) +[`[number]`](/docs/kcl/types/[number]) ### Examples diff --git a/docs/kcl/profileStart.md b/docs/kcl/profileStart.md index 3005cb5df..707ae8397 100644 --- a/docs/kcl/profileStart.md +++ b/docs/kcl/profileStart.md @@ -17,11 +17,11 @@ profileStart(sketch_group: SketchGroup) -> [number] | Name | Type | Description | Required | |----------|------|-------------|----------| -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | ### Returns -[`[number]`](kcl/types/[number]) +[`[number]`](/docs/kcl/types/[number]) ### Examples diff --git a/docs/kcl/profileStartX.md b/docs/kcl/profileStartX.md index a010d2414..149deadbd 100644 --- a/docs/kcl/profileStartX.md +++ b/docs/kcl/profileStartX.md @@ -17,7 +17,7 @@ profileStartX(sketch_group: SketchGroup) -> number | Name | Type | Description | Required | |----------|------|-------------|----------| -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | ### Returns diff --git a/docs/kcl/profileStartY.md b/docs/kcl/profileStartY.md index a2e306bbe..7e1fc7123 100644 --- a/docs/kcl/profileStartY.md +++ b/docs/kcl/profileStartY.md @@ -17,7 +17,7 @@ profileStartY(sketch_group: SketchGroup) -> number | Name | Type | Description | Required | |----------|------|-------------|----------| -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | ### Returns diff --git a/docs/kcl/revolve.md b/docs/kcl/revolve.md index b69fb5693..7f2f10d81 100644 --- a/docs/kcl/revolve.md +++ b/docs/kcl/revolve.md @@ -18,12 +18,12 @@ revolve(data: RevolveData, sketch_group: SketchGroup) -> ExtrudeGroup | Name | Type | Description | Required | |----------|------|-------------|----------| -| `data` | [`RevolveData`](kcl/types/RevolveData) | Data for revolution surfaces. | Yes | -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `data` | [`RevolveData`](/docs/kcl/types/RevolveData) | Data for revolution surfaces. | Yes | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | ### Returns -[`ExtrudeGroup`](kcl/types/ExtrudeGroup) - An extrude group is a collection of extrude surfaces. +[`ExtrudeGroup`](/docs/kcl/types/ExtrudeGroup) - An extrude group is a collection of extrude surfaces. ### Examples diff --git a/docs/kcl/segAng.md b/docs/kcl/segAng.md index e8916cdae..377e1c400 100644 --- a/docs/kcl/segAng.md +++ b/docs/kcl/segAng.md @@ -17,7 +17,7 @@ segAng(tag: TagIdentifier) -> number | Name | Type | Description | Required | |----------|------|-------------|----------| -| `tag` | [`TagIdentifier`](kcl/types#tag-identifier) | | Yes | +| `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | | Yes | ### Returns diff --git a/docs/kcl/segEndX.md b/docs/kcl/segEndX.md index ab113c02b..83c00872c 100644 --- a/docs/kcl/segEndX.md +++ b/docs/kcl/segEndX.md @@ -17,7 +17,7 @@ segEndX(tag: TagIdentifier) -> number | Name | Type | Description | Required | |----------|------|-------------|----------| -| `tag` | [`TagIdentifier`](kcl/types#tag-identifier) | | Yes | +| `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | | Yes | ### Returns diff --git a/docs/kcl/segEndY.md b/docs/kcl/segEndY.md index 42350371e..1571bfe08 100644 --- a/docs/kcl/segEndY.md +++ b/docs/kcl/segEndY.md @@ -17,7 +17,7 @@ segEndY(tag: TagIdentifier) -> number | Name | Type | Description | Required | |----------|------|-------------|----------| -| `tag` | [`TagIdentifier`](kcl/types#tag-identifier) | | Yes | +| `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | | Yes | ### Returns diff --git a/docs/kcl/segLen.md b/docs/kcl/segLen.md index bbb2cbe8e..0d17241b6 100644 --- a/docs/kcl/segLen.md +++ b/docs/kcl/segLen.md @@ -17,7 +17,7 @@ segLen(tag: TagIdentifier) -> number | Name | Type | Description | Required | |----------|------|-------------|----------| -| `tag` | [`TagIdentifier`](kcl/types#tag-identifier) | | Yes | +| `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | | Yes | ### Returns diff --git a/docs/kcl/shell.md b/docs/kcl/shell.md index ef4b739da..ee0a0039c 100644 --- a/docs/kcl/shell.md +++ b/docs/kcl/shell.md @@ -17,12 +17,12 @@ shell(data: ShellData, extrude_group_set: ExtrudeGroupSet) -> ExtrudeGroupSet | Name | Type | Description | Required | |----------|------|-------------|----------| -| `data` | [`ShellData`](kcl/types/ShellData) | Data for shells. | Yes | -| `extrude_group_set` | [`ExtrudeGroupSet`](kcl/types/ExtrudeGroupSet) | A extrude group or a group of extrude groups. | Yes | +| `data` | [`ShellData`](/docs/kcl/types/ShellData) | Data for shells. | Yes | +| `extrude_group_set` | [`ExtrudeGroupSet`](/docs/kcl/types/ExtrudeGroupSet) | A extrude group or a group of extrude groups. | Yes | ### Returns -[`ExtrudeGroupSet`](kcl/types/ExtrudeGroupSet) - A extrude group or a group of extrude groups. +[`ExtrudeGroupSet`](/docs/kcl/types/ExtrudeGroupSet) - A extrude group or a group of extrude groups. ### Examples diff --git a/docs/kcl/startProfileAt.md b/docs/kcl/startProfileAt.md index ff8bea98a..62b8af48a 100644 --- a/docs/kcl/startProfileAt.md +++ b/docs/kcl/startProfileAt.md @@ -17,13 +17,13 @@ startProfileAt(to: [number], sketch_surface: SketchSurface, tag?: TagDeclarator) | Name | Type | Description | Required | |----------|------|-------------|----------| -| `to` | [`[number]`](kcl/types/[number]) | | Yes | -| `sketch_surface` | [`SketchSurface`](kcl/types/SketchSurface) | A sketch group type. | Yes | -| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | +| `to` | [`[number]`](/docs/kcl/types/[number]) | | Yes | +| `sketch_surface` | [`SketchSurface`](/docs/kcl/types/SketchSurface) | A sketch group type. | Yes | +| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No | ### Returns -[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. +[`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths. ### Examples diff --git a/docs/kcl/startSketchAt.md b/docs/kcl/startSketchAt.md index 1c4e61bef..4a28e08da 100644 --- a/docs/kcl/startSketchAt.md +++ b/docs/kcl/startSketchAt.md @@ -17,11 +17,11 @@ startSketchAt(data: [number]) -> SketchGroup | Name | Type | Description | Required | |----------|------|-------------|----------| -| `data` | [`[number]`](kcl/types/[number]) | | Yes | +| `data` | [`[number]`](/docs/kcl/types/[number]) | | Yes | ### Returns -[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. +[`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths. ### Examples diff --git a/docs/kcl/startSketchOn.md b/docs/kcl/startSketchOn.md index 7d91a0f91..c45625a9d 100644 --- a/docs/kcl/startSketchOn.md +++ b/docs/kcl/startSketchOn.md @@ -17,12 +17,12 @@ startSketchOn(data: SketchData, tag?: FaceTag) -> SketchSurface | Name | Type | Description | Required | |----------|------|-------------|----------| -| `data` | [`SketchData`](kcl/types/SketchData) | Data for start sketch on. You can start a sketch on a plane or an extrude group. | Yes | -| `tag` | [`FaceTag`](kcl/types/FaceTag) | A tag for a face. | No | +| `data` | [`SketchData`](/docs/kcl/types/SketchData) | Data for start sketch on. You can start a sketch on a plane or an extrude group. | Yes | +| `tag` | [`FaceTag`](/docs/kcl/types/FaceTag) | A tag for a face. | No | ### Returns -[`SketchSurface`](kcl/types/SketchSurface) - A sketch group type. +[`SketchSurface`](/docs/kcl/types/SketchSurface) - A sketch group type. ### Examples diff --git a/docs/kcl/tangentialArc.md b/docs/kcl/tangentialArc.md index 0d5e77a6c..c3a64434c 100644 --- a/docs/kcl/tangentialArc.md +++ b/docs/kcl/tangentialArc.md @@ -18,13 +18,13 @@ tangentialArc(data: TangentialArcData, sketch_group: SketchGroup, tag?: TagDecla | Name | Type | Description | Required | |----------|------|-------------|----------| -| `data` | [`TangentialArcData`](kcl/types/TangentialArcData) | Data to draw a tangential arc. | Yes | -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | -| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | +| `data` | [`TangentialArcData`](/docs/kcl/types/TangentialArcData) | Data to draw a tangential arc. | Yes | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No | ### Returns -[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. +[`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths. ### Examples diff --git a/docs/kcl/tangentialArcTo.md b/docs/kcl/tangentialArcTo.md index 540e9058c..18ced4c67 100644 --- a/docs/kcl/tangentialArcTo.md +++ b/docs/kcl/tangentialArcTo.md @@ -17,13 +17,13 @@ tangentialArcTo(to: [number], sketch_group: SketchGroup, tag?: TagDeclarator) -> | Name | Type | Description | Required | |----------|------|-------------|----------| -| `to` | [`[number]`](kcl/types/[number]) | | Yes | -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | -| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | +| `to` | [`[number]`](/docs/kcl/types/[number]) | | Yes | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No | ### Returns -[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. +[`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths. ### Examples diff --git a/docs/kcl/tangentialArcToRelative.md b/docs/kcl/tangentialArcToRelative.md index dc4953e8a..23e129072 100644 --- a/docs/kcl/tangentialArcToRelative.md +++ b/docs/kcl/tangentialArcToRelative.md @@ -17,13 +17,13 @@ tangentialArcToRelative(delta: [number], sketch_group: SketchGroup, tag?: TagDec | Name | Type | Description | Required | |----------|------|-------------|----------| -| `delta` | [`[number]`](kcl/types/[number]) | | Yes | -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | -| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | +| `delta` | [`[number]`](/docs/kcl/types/[number]) | | Yes | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No | ### Returns -[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. +[`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths. ### Examples diff --git a/docs/kcl/xLine.md b/docs/kcl/xLine.md index 973e193c9..49bb75a28 100644 --- a/docs/kcl/xLine.md +++ b/docs/kcl/xLine.md @@ -18,12 +18,12 @@ xLine(length: number, sketch_group: SketchGroup, tag?: TagDeclarator) -> SketchG | Name | Type | Description | Required | |----------|------|-------------|----------| | `length` | `number` | | Yes | -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | -| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No | ### Returns -[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. +[`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths. ### Examples diff --git a/docs/kcl/xLineTo.md b/docs/kcl/xLineTo.md index 9ae6cdbcc..61fcc7ac3 100644 --- a/docs/kcl/xLineTo.md +++ b/docs/kcl/xLineTo.md @@ -18,12 +18,12 @@ xLineTo(to: number, sketch_group: SketchGroup, tag?: TagDeclarator) -> SketchGro | Name | Type | Description | Required | |----------|------|-------------|----------| | `to` | `number` | | Yes | -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | -| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No | ### Returns -[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. +[`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths. ### Examples diff --git a/docs/kcl/yLine.md b/docs/kcl/yLine.md index b676adf8f..e9b90f420 100644 --- a/docs/kcl/yLine.md +++ b/docs/kcl/yLine.md @@ -18,12 +18,12 @@ yLine(length: number, sketch_group: SketchGroup, tag?: TagDeclarator) -> SketchG | Name | Type | Description | Required | |----------|------|-------------|----------| | `length` | `number` | | Yes | -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | -| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No | ### Returns -[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. +[`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths. ### Examples diff --git a/docs/kcl/yLineTo.md b/docs/kcl/yLineTo.md index 0e788e29c..a167cc625 100644 --- a/docs/kcl/yLineTo.md +++ b/docs/kcl/yLineTo.md @@ -18,12 +18,12 @@ yLineTo(to: number, sketch_group: SketchGroup, tag?: TagDeclarator) -> SketchGro | Name | Type | Description | Required | |----------|------|-------------|----------| | `to` | `number` | | Yes | -| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | -| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No | +| `sketch_group` | [`SketchGroup`](/docs/kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes | +| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No | ### Returns -[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths. +[`SketchGroup`](/docs/kcl/types/SketchGroup) - A sketch group is a collection of paths. ### Examples diff --git a/src/wasm-lib/kcl/src/docs/gen_std_tests.rs b/src/wasm-lib/kcl/src/docs/gen_std_tests.rs index 60179248a..d799495c8 100644 --- a/src/wasm-lib/kcl/src/docs/gen_std_tests.rs +++ b/src/wasm-lib/kcl/src/docs/gen_std_tests.rs @@ -152,7 +152,7 @@ fn generate_index(combined: &HashMap>) -> Result<()> { let output = hbs.render("index", &data)?; - std::fs::write("../../../docs/kcl/index.md", output)?; + expectorate::assert_contents("../../../docs/kcl/index.md", &output); Ok(()) } @@ -245,18 +245,18 @@ fn generate_function(internal_fn: Box) -> Result<()> { for type_name in types { let formatted_type_name = format!("`{}`", type_name); if type_name == "TagDeclarator" { - let link = format!("[`{}`](kcl/types#tag-declaration)", "TagDeclarator"); + let link = format!("[`{}`](/docs/kcl/types#tag-declaration)", "TagDeclarator"); output = output.replace(&formatted_type_name, &link); } else if type_name == "TagIdentifier" { - let link = format!("[`{}`](kcl/types#tag-identifier)", "TagIdentifier"); + let link = format!("[`{}`](/docs/kcl/types#tag-identifier)", "TagIdentifier"); output = output.replace(&formatted_type_name, &link); } else { - let link = format!("[`{}`](kcl/types/{})", type_name, type_name); + let link = format!("[`{}`](/docs/kcl/types/{})", type_name, type_name); output = output.replace(&formatted_type_name, &link); } } - std::fs::write(format!("../../../docs/kcl/{}.md", fn_name), output)?; + expectorate::assert_contents(format!("../../../docs/kcl/{}.md", fn_name), &output); Ok(()) } @@ -334,7 +334,7 @@ fn generate_type(name: &str, schema: &schemars::schema::Schema) -> Result<()> { let data = json!(schemars::schema::Schema::Object(object)); let output = hbs.render("type", &data)?; - std::fs::write(format!("{}/{}.md", TYPES_DIR, name), output)?; + expectorate::assert_contents(format!("{}/{}.md", TYPES_DIR, name), &output); Ok(()) }