Fixes for docs (#1712)

This commit is contained in:
Jess Frazelle
2024-03-13 15:01:35 -07:00
committed by GitHub
parent 4be9f70965
commit 5d7d15a385
2 changed files with 71 additions and 79 deletions

View File

@ -4,77 +4,73 @@ excerpt: "Documentation for the KCL standard library for the Zoo Modeling App."
layout: manual layout: manual
--- ---
# KCL Standard Library
## Types
## Table of Contents ## Table of Contents
* [Types](types.md) * [Types](kcl/types)
* [Known Issues](KNOWN-ISSUES.md) * [Known Issues](kcl/KNOWN-ISSUES)
* [`abs`](abs.md) * [`abs`](kcl/abs)
* [`acos`](acos.md) * [`acos`](kcl/acos)
* [`angleToMatchLengthX`](angleToMatchLengthX.md) * [`angleToMatchLengthX`](kcl/angleToMatchLengthX)
* [`angleToMatchLengthY`](angleToMatchLengthY.md) * [`angleToMatchLengthY`](kcl/angleToMatchLengthY)
* [`angledLine`](angledLine.md) * [`angledLine`](kcl/angledLine)
* [`angledLineOfXLength`](angledLineOfXLength.md) * [`angledLineOfXLength`](kcl/angledLineOfXLength)
* [`angledLineOfYLength`](angledLineOfYLength.md) * [`angledLineOfYLength`](kcl/angledLineOfYLength)
* [`angledLineThatIntersects`](angledLineThatIntersects.md) * [`angledLineThatIntersects`](kcl/angledLineThatIntersects)
* [`angledLineToX`](angledLineToX.md) * [`angledLineToX`](kcl/angledLineToX)
* [`angledLineToY`](angledLineToY.md) * [`angledLineToY`](kcl/angledLineToY)
* [`arc`](arc.md) * [`arc`](kcl/arc)
* [`asin`](asin.md) * [`asin`](kcl/asin)
* [`atan`](atan.md) * [`atan`](kcl/atan)
* [`bezierCurve`](bezierCurve.md) * [`bezierCurve`](kcl/bezierCurve)
* [`ceil`](ceil.md) * [`ceil`](kcl/ceil)
* [`circle`](circle.md) * [`circle`](kcl/circle)
* [`close`](close.md) * [`close`](kcl/close)
* [`cos`](cos.md) * [`cos`](kcl/cos)
* [`e`](e.md) * [`e`](kcl/e)
* [`extrude`](extrude.md) * [`extrude`](kcl/extrude)
* [`fillet`](fillet.md) * [`fillet`](kcl/fillet)
* [`floor`](floor.md) * [`floor`](kcl/floor)
* [`getExtrudeWallTransform`](getExtrudeWallTransform.md) * [`getExtrudeWallTransform`](kcl/getExtrudeWallTransform)
* [`getNextAdjacentEdge`](getNextAdjacentEdge.md) * [`getNextAdjacentEdge`](kcl/getNextAdjacentEdge)
* [`getOppositeEdge`](getOppositeEdge.md) * [`getOppositeEdge`](kcl/getOppositeEdge)
* [`getPreviousAdjacentEdge`](getPreviousAdjacentEdge.md) * [`getPreviousAdjacentEdge`](kcl/getPreviousAdjacentEdge)
* [`hole`](hole.md) * [`hole`](kcl/hole)
* [`import`](import.md) * [`import`](kcl/import)
* [`lastSegX`](lastSegX.md) * [`lastSegX`](kcl/lastSegX)
* [`lastSegY`](lastSegY.md) * [`lastSegY`](kcl/lastSegY)
* [`legAngX`](legAngX.md) * [`legAngX`](kcl/legAngX)
* [`legAngY`](legAngY.md) * [`legAngY`](kcl/legAngY)
* [`legLen`](legLen.md) * [`legLen`](kcl/legLen)
* [`line`](line.md) * [`line`](kcl/line)
* [`lineTo`](lineTo.md) * [`lineTo`](kcl/lineTo)
* [`ln`](ln.md) * [`ln`](kcl/ln)
* [`log`](log.md) * [`log`](kcl/log)
* [`log10`](log10.md) * [`log10`](kcl/log10)
* [`log2`](log2.md) * [`log2`](kcl/log2)
* [`max`](max.md) * [`max`](kcl/max)
* [`min`](min.md) * [`min`](kcl/min)
* [`patternCircular2d`](patternCircular2d.md) * [`patternCircular2d`](kcl/patternCircular2d)
* [`patternCircular3d`](patternCircular3d.md) * [`patternCircular3d`](kcl/patternCircular3d)
* [`patternLinear2d`](patternLinear2d.md) * [`patternLinear2d`](kcl/patternLinear2d)
* [`patternLinear3d`](patternLinear3d.md) * [`patternLinear3d`](kcl/patternLinear3d)
* [`pi`](pi.md) * [`pi`](kcl/pi)
* [`pow`](pow.md) * [`pow`](kcl/pow)
* [`segAng`](segAng.md) * [`segAng`](kcl/segAng)
* [`segEndX`](segEndX.md) * [`segEndX`](kcl/segEndX)
* [`segEndY`](segEndY.md) * [`segEndY`](kcl/segEndY)
* [`segLen`](segLen.md) * [`segLen`](kcl/segLen)
* [`sin`](sin.md) * [`sin`](kcl/sin)
* [`sqrt`](sqrt.md) * [`sqrt`](kcl/sqrt)
* [`startProfileAt`](startProfileAt.md) * [`startProfileAt`](kcl/startProfileAt)
* [`startSketchAt`](startSketchAt.md) * [`startSketchAt`](kcl/startSketchAt)
* [`startSketchOn`](startSketchOn.md) * [`startSketchOn`](kcl/startSketchOn)
* [`tan`](tan.md) * [`tan`](kcl/tan)
* [`tangentialArc`](tangentialArc.md) * [`tangentialArc`](kcl/tangentialArc)
* [`tangentialArcTo`](tangentialArcTo.md) * [`tangentialArcTo`](kcl/tangentialArcTo)
* [`tau`](tau.md) * [`tau`](kcl/tau)
* [`toDegrees`](toDegrees.md) * [`toDegrees`](kcl/toDegrees)
* [`toRadians`](toRadians.md) * [`toRadians`](kcl/toRadians)
* [`xLine`](xLine.md) * [`xLine`](kcl/xLine)
* [`xLineTo`](xLineTo.md) * [`xLineTo`](kcl/xLineTo)
* [`yLine`](yLine.md) * [`yLine`](kcl/yLine)
* [`yLineTo`](yLineTo.md) * [`yLineTo`](kcl/yLineTo)

View File

@ -845,15 +845,11 @@ layout: manual
"#, "#,
); );
buf.push_str("# KCL Standard Library\n\n");
buf.push_str("## Types\n\n");
// Generate a table of contents. // Generate a table of contents.
buf.push_str("## Table of Contents\n\n"); buf.push_str("## Table of Contents\n\n");
buf.push_str("* [Types](types.md)\n"); buf.push_str("* [Types](kcl/types)\n");
buf.push_str("* [Known Issues](KNOWN-ISSUES.md)\n"); buf.push_str("* [Known Issues](kcl/KNOWN-ISSUES)\n");
for key in combined.keys().sorted() { for key in combined.keys().sorted() {
let internal_fn = combined.get(key).unwrap(); let internal_fn = combined.get(key).unwrap();
@ -861,7 +857,7 @@ layout: manual
continue; 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. // Write the index.