Skip to content

Commit

Permalink
Fixes for docs (#1712)
Browse files Browse the repository at this point in the history
  • Loading branch information
jessfraz authored Mar 13, 2024
1 parent 4be9f70 commit 5d7d15a
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 79 deletions.
140 changes: 68 additions & 72 deletions docs/kcl/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,77 +4,73 @@ excerpt: "Documentation for the KCL standard library for the Zoo Modeling App."
layout: manual
---

# KCL Standard Library

## Types

## Table of Contents

* [Types](types.md)
* [Known Issues](KNOWN-ISSUES.md)
* [`abs`](abs.md)
* [`acos`](acos.md)
* [`angleToMatchLengthX`](angleToMatchLengthX.md)
* [`angleToMatchLengthY`](angleToMatchLengthY.md)
* [`angledLine`](angledLine.md)
* [`angledLineOfXLength`](angledLineOfXLength.md)
* [`angledLineOfYLength`](angledLineOfYLength.md)
* [`angledLineThatIntersects`](angledLineThatIntersects.md)
* [`angledLineToX`](angledLineToX.md)
* [`angledLineToY`](angledLineToY.md)
* [`arc`](arc.md)
* [`asin`](asin.md)
* [`atan`](atan.md)
* [`bezierCurve`](bezierCurve.md)
* [`ceil`](ceil.md)
* [`circle`](circle.md)
* [`close`](close.md)
* [`cos`](cos.md)
* [`e`](e.md)
* [`extrude`](extrude.md)
* [`fillet`](fillet.md)
* [`floor`](floor.md)
* [`getExtrudeWallTransform`](getExtrudeWallTransform.md)
* [`getNextAdjacentEdge`](getNextAdjacentEdge.md)
* [`getOppositeEdge`](getOppositeEdge.md)
* [`getPreviousAdjacentEdge`](getPreviousAdjacentEdge.md)
* [`hole`](hole.md)
* [`import`](import.md)
* [`lastSegX`](lastSegX.md)
* [`lastSegY`](lastSegY.md)
* [`legAngX`](legAngX.md)
* [`legAngY`](legAngY.md)
* [`legLen`](legLen.md)
* [`line`](line.md)
* [`lineTo`](lineTo.md)
* [`ln`](ln.md)
* [`log`](log.md)
* [`log10`](log10.md)
* [`log2`](log2.md)
* [`max`](max.md)
* [`min`](min.md)
* [`patternCircular2d`](patternCircular2d.md)
* [`patternCircular3d`](patternCircular3d.md)
* [`patternLinear2d`](patternLinear2d.md)
* [`patternLinear3d`](patternLinear3d.md)
* [`pi`](pi.md)
* [`pow`](pow.md)
* [`segAng`](segAng.md)
* [`segEndX`](segEndX.md)
* [`segEndY`](segEndY.md)
* [`segLen`](segLen.md)
* [`sin`](sin.md)
* [`sqrt`](sqrt.md)
* [`startProfileAt`](startProfileAt.md)
* [`startSketchAt`](startSketchAt.md)
* [`startSketchOn`](startSketchOn.md)
* [`tan`](tan.md)
* [`tangentialArc`](tangentialArc.md)
* [`tangentialArcTo`](tangentialArcTo.md)
* [`tau`](tau.md)
* [`toDegrees`](toDegrees.md)
* [`toRadians`](toRadians.md)
* [`xLine`](xLine.md)
* [`xLineTo`](xLineTo.md)
* [`yLine`](yLine.md)
* [`yLineTo`](yLineTo.md)
* [Types](kcl/types)
* [Known Issues](kcl/KNOWN-ISSUES)
* [`abs`](kcl/abs)
* [`acos`](kcl/acos)
* [`angleToMatchLengthX`](kcl/angleToMatchLengthX)
* [`angleToMatchLengthY`](kcl/angleToMatchLengthY)
* [`angledLine`](kcl/angledLine)
* [`angledLineOfXLength`](kcl/angledLineOfXLength)
* [`angledLineOfYLength`](kcl/angledLineOfYLength)
* [`angledLineThatIntersects`](kcl/angledLineThatIntersects)
* [`angledLineToX`](kcl/angledLineToX)
* [`angledLineToY`](kcl/angledLineToY)
* [`arc`](kcl/arc)
* [`asin`](kcl/asin)
* [`atan`](kcl/atan)
* [`bezierCurve`](kcl/bezierCurve)
* [`ceil`](kcl/ceil)
* [`circle`](kcl/circle)
* [`close`](kcl/close)
* [`cos`](kcl/cos)
* [`e`](kcl/e)
* [`extrude`](kcl/extrude)
* [`fillet`](kcl/fillet)
* [`floor`](kcl/floor)
* [`getExtrudeWallTransform`](kcl/getExtrudeWallTransform)
* [`getNextAdjacentEdge`](kcl/getNextAdjacentEdge)
* [`getOppositeEdge`](kcl/getOppositeEdge)
* [`getPreviousAdjacentEdge`](kcl/getPreviousAdjacentEdge)
* [`hole`](kcl/hole)
* [`import`](kcl/import)
* [`lastSegX`](kcl/lastSegX)
* [`lastSegY`](kcl/lastSegY)
* [`legAngX`](kcl/legAngX)
* [`legAngY`](kcl/legAngY)
* [`legLen`](kcl/legLen)
* [`line`](kcl/line)
* [`lineTo`](kcl/lineTo)
* [`ln`](kcl/ln)
* [`log`](kcl/log)
* [`log10`](kcl/log10)
* [`log2`](kcl/log2)
* [`max`](kcl/max)
* [`min`](kcl/min)
* [`patternCircular2d`](kcl/patternCircular2d)
* [`patternCircular3d`](kcl/patternCircular3d)
* [`patternLinear2d`](kcl/patternLinear2d)
* [`patternLinear3d`](kcl/patternLinear3d)
* [`pi`](kcl/pi)
* [`pow`](kcl/pow)
* [`segAng`](kcl/segAng)
* [`segEndX`](kcl/segEndX)
* [`segEndY`](kcl/segEndY)
* [`segLen`](kcl/segLen)
* [`sin`](kcl/sin)
* [`sqrt`](kcl/sqrt)
* [`startProfileAt`](kcl/startProfileAt)
* [`startSketchAt`](kcl/startSketchAt)
* [`startSketchOn`](kcl/startSketchOn)
* [`tan`](kcl/tan)
* [`tangentialArc`](kcl/tangentialArc)
* [`tangentialArcTo`](kcl/tangentialArcTo)
* [`tau`](kcl/tau)
* [`toDegrees`](kcl/toDegrees)
* [`toRadians`](kcl/toRadians)
* [`xLine`](kcl/xLine)
* [`xLineTo`](kcl/xLineTo)
* [`yLine`](kcl/yLine)
* [`yLineTo`](kcl/yLineTo)
10 changes: 3 additions & 7 deletions src/wasm-lib/kcl/src/std/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -845,23 +845,19 @@ layout: manual
"#,
);

buf.push_str("# KCL Standard Library\n\n");

buf.push_str("## Types\n\n");

// Generate a table of contents.
buf.push_str("## Table of Contents\n\n");

buf.push_str("* [Types](types.md)\n");
buf.push_str("* [Known Issues](KNOWN-ISSUES.md)\n");
buf.push_str("* [Types](kcl/types)\n");
buf.push_str("* [Known Issues](kcl/KNOWN-ISSUES)\n");

for key in combined.keys().sorted() {
let internal_fn = combined.get(key).unwrap();
if internal_fn.unpublished() || internal_fn.deprecated() {
continue;
}

buf.push_str(&format!("* [`{}`]({}.md)\n", internal_fn.name(), internal_fn.name()));
buf.push_str(&format!("* [`{}`](kcl/{})\n", internal_fn.name(), internal_fn.name()));
}

// Write the index.
Expand Down

0 comments on commit 5d7d15a

Please sign in to comment.