Add modules to docs (#6699)
* Support modules in docs Signed-off-by: Nick Cameron <nrc@ncameron.org> * shuffle around directories Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org>
This commit is contained in:
124
docs/kcl-std/functions/std-helix.md
Normal file
124
docs/kcl-std/functions/std-helix.md
Normal file
File diff suppressed because one or more lines are too long
51
docs/kcl-std/functions/std-math-abs.md
Normal file
51
docs/kcl-std/functions/std-math-abs.md
Normal file
File diff suppressed because one or more lines are too long
45
docs/kcl-std/functions/std-math-acos.md
Normal file
45
docs/kcl-std/functions/std-math-acos.md
Normal file
File diff suppressed because one or more lines are too long
44
docs/kcl-std/functions/std-math-asin.md
Normal file
44
docs/kcl-std/functions/std-math-asin.md
Normal file
File diff suppressed because one or more lines are too long
43
docs/kcl-std/functions/std-math-atan.md
Normal file
43
docs/kcl-std/functions/std-math-atan.md
Normal file
@ -0,0 +1,43 @@
|
||||
---
|
||||
title: "std::math::atan"
|
||||
excerpt: "Compute the arctangent of a number."
|
||||
layout: manual
|
||||
---
|
||||
|
||||
Compute the arctangent of a number.
|
||||
|
||||
Consider using `atan2()` instead for the true inverse of tangent.
|
||||
|
||||
```kcl
|
||||
atan(@num: number(_)): number(rad)
|
||||
```
|
||||
|
||||
|
||||
### Arguments
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
|----------|------|-------------|----------|
|
||||
| `num` | `number(_)` | | Yes |
|
||||
|
||||
### Returns
|
||||
|
||||
`number(rad)`
|
||||
|
||||
|
||||
### Examples
|
||||
|
||||
```kcl
|
||||
sketch001 = startSketchOn(XZ)
|
||||
|> startProfile(at = [0, 0])
|
||||
|> angledLine(
|
||||
angle = atan(1.25),
|
||||
length = 20,
|
||||
)
|
||||
|> yLine(endAbsolute = 0)
|
||||
|> close()
|
||||
|
||||
extrude001 = extrude(sketch001, length = 5)
|
||||
```
|
||||
|
||||
|
||||
|
48
docs/kcl-std/functions/std-math-atan2.md
Normal file
48
docs/kcl-std/functions/std-math-atan2.md
Normal file
File diff suppressed because one or more lines are too long
42
docs/kcl-std/functions/std-math-ceil.md
Normal file
42
docs/kcl-std/functions/std-math-ceil.md
Normal file
File diff suppressed because one or more lines are too long
44
docs/kcl-std/functions/std-math-cos.md
Normal file
44
docs/kcl-std/functions/std-math-cos.md
Normal file
File diff suppressed because one or more lines are too long
42
docs/kcl-std/functions/std-math-floor.md
Normal file
42
docs/kcl-std/functions/std-math-floor.md
Normal file
File diff suppressed because one or more lines are too long
42
docs/kcl-std/functions/std-math-ln.md
Normal file
42
docs/kcl-std/functions/std-math-ln.md
Normal file
File diff suppressed because one or more lines are too long
48
docs/kcl-std/functions/std-math-log.md
Normal file
48
docs/kcl-std/functions/std-math-log.md
Normal file
File diff suppressed because one or more lines are too long
42
docs/kcl-std/functions/std-math-log10.md
Normal file
42
docs/kcl-std/functions/std-math-log10.md
Normal file
File diff suppressed because one or more lines are too long
42
docs/kcl-std/functions/std-math-log2.md
Normal file
42
docs/kcl-std/functions/std-math-log2.md
Normal file
File diff suppressed because one or more lines are too long
44
docs/kcl-std/functions/std-math-max.md
Normal file
44
docs/kcl-std/functions/std-math-max.md
Normal file
File diff suppressed because one or more lines are too long
44
docs/kcl-std/functions/std-math-min.md
Normal file
44
docs/kcl-std/functions/std-math-min.md
Normal file
File diff suppressed because one or more lines are too long
48
docs/kcl-std/functions/std-math-polar.md
Normal file
48
docs/kcl-std/functions/std-math-polar.md
Normal file
File diff suppressed because one or more lines are too long
48
docs/kcl-std/functions/std-math-pow.md
Normal file
48
docs/kcl-std/functions/std-math-pow.md
Normal file
File diff suppressed because one or more lines are too long
47
docs/kcl-std/functions/std-math-rem.md
Normal file
47
docs/kcl-std/functions/std-math-rem.md
Normal file
File diff suppressed because one or more lines are too long
42
docs/kcl-std/functions/std-math-round.md
Normal file
42
docs/kcl-std/functions/std-math-round.md
Normal file
File diff suppressed because one or more lines are too long
44
docs/kcl-std/functions/std-math-sin.md
Normal file
44
docs/kcl-std/functions/std-math-sin.md
Normal file
File diff suppressed because one or more lines are too long
44
docs/kcl-std/functions/std-math-sqrt.md
Normal file
44
docs/kcl-std/functions/std-math-sqrt.md
Normal file
File diff suppressed because one or more lines are too long
44
docs/kcl-std/functions/std-math-tan.md
Normal file
44
docs/kcl-std/functions/std-math-tan.md
Normal file
File diff suppressed because one or more lines are too long
122
docs/kcl-std/functions/std-offsetPlane.md
Normal file
122
docs/kcl-std/functions/std-offsetPlane.md
Normal file
File diff suppressed because one or more lines are too long
287
docs/kcl-std/functions/std-revolve.md
Normal file
287
docs/kcl-std/functions/std-revolve.md
Normal file
File diff suppressed because one or more lines are too long
61
docs/kcl-std/functions/std-sketch-circle.md
Normal file
61
docs/kcl-std/functions/std-sketch-circle.md
Normal file
File diff suppressed because one or more lines are too long
122
docs/kcl-std/functions/std-sketch-mirror2d.md
Normal file
122
docs/kcl-std/functions/std-sketch-mirror2d.md
Normal file
File diff suppressed because one or more lines are too long
101
docs/kcl-std/functions/std-solid-chamfer.md
Normal file
101
docs/kcl-std/functions/std-solid-chamfer.md
Normal file
File diff suppressed because one or more lines are too long
96
docs/kcl-std/functions/std-solid-fillet.md
Normal file
96
docs/kcl-std/functions/std-solid-fillet.md
Normal file
File diff suppressed because one or more lines are too long
86
docs/kcl-std/functions/std-solid-hollow.md
Normal file
86
docs/kcl-std/functions/std-solid-hollow.md
Normal file
File diff suppressed because one or more lines are too long
193
docs/kcl-std/functions/std-solid-shell.md
Normal file
193
docs/kcl-std/functions/std-solid-shell.md
Normal file
File diff suppressed because one or more lines are too long
27
docs/kcl-std/functions/std-units-toCentimeters.md
Normal file
27
docs/kcl-std/functions/std-units-toCentimeters.md
Normal file
@ -0,0 +1,27 @@
|
||||
---
|
||||
title: "std::units::toCentimeters"
|
||||
excerpt: "Convert a number to centimeters from its current units."
|
||||
layout: manual
|
||||
---
|
||||
|
||||
Convert a number to centimeters from its current units.
|
||||
|
||||
|
||||
|
||||
```kcl
|
||||
units::toCentimeters(@num: number(cm)): number(cm)
|
||||
```
|
||||
|
||||
|
||||
### Arguments
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
|----------|------|-------------|----------|
|
||||
| `num` | `number(cm)` | | Yes |
|
||||
|
||||
### Returns
|
||||
|
||||
`number(cm)`
|
||||
|
||||
|
||||
|
44
docs/kcl-std/functions/std-units-toDegrees.md
Normal file
44
docs/kcl-std/functions/std-units-toDegrees.md
Normal file
File diff suppressed because one or more lines are too long
27
docs/kcl-std/functions/std-units-toFeet.md
Normal file
27
docs/kcl-std/functions/std-units-toFeet.md
Normal file
@ -0,0 +1,27 @@
|
||||
---
|
||||
title: "std::units::toFeet"
|
||||
excerpt: "Convert a number to feet from its current units."
|
||||
layout: manual
|
||||
---
|
||||
|
||||
Convert a number to feet from its current units.
|
||||
|
||||
|
||||
|
||||
```kcl
|
||||
units::toFeet(@num: number(ft)): number(ft)
|
||||
```
|
||||
|
||||
|
||||
### Arguments
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
|----------|------|-------------|----------|
|
||||
| `num` | `number(ft)` | | Yes |
|
||||
|
||||
### Returns
|
||||
|
||||
`number(ft)`
|
||||
|
||||
|
||||
|
27
docs/kcl-std/functions/std-units-toInches.md
Normal file
27
docs/kcl-std/functions/std-units-toInches.md
Normal file
@ -0,0 +1,27 @@
|
||||
---
|
||||
title: "std::units::toInches"
|
||||
excerpt: "Convert a number to inches from its current units."
|
||||
layout: manual
|
||||
---
|
||||
|
||||
Convert a number to inches from its current units.
|
||||
|
||||
|
||||
|
||||
```kcl
|
||||
units::toInches(@num: number(in)): number(in)
|
||||
```
|
||||
|
||||
|
||||
### Arguments
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
|----------|------|-------------|----------|
|
||||
| `num` | `number(in)` | | Yes |
|
||||
|
||||
### Returns
|
||||
|
||||
`number(in)`
|
||||
|
||||
|
||||
|
27
docs/kcl-std/functions/std-units-toMeters.md
Normal file
27
docs/kcl-std/functions/std-units-toMeters.md
Normal file
@ -0,0 +1,27 @@
|
||||
---
|
||||
title: "std::units::toMeters"
|
||||
excerpt: "Convert a number to meters from its current units."
|
||||
layout: manual
|
||||
---
|
||||
|
||||
Convert a number to meters from its current units.
|
||||
|
||||
|
||||
|
||||
```kcl
|
||||
units::toMeters(@num: number(m)): number(m)
|
||||
```
|
||||
|
||||
|
||||
### Arguments
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
|----------|------|-------------|----------|
|
||||
| `num` | `number(m)` | | Yes |
|
||||
|
||||
### Returns
|
||||
|
||||
`number(m)`
|
||||
|
||||
|
||||
|
27
docs/kcl-std/functions/std-units-toMillimeters.md
Normal file
27
docs/kcl-std/functions/std-units-toMillimeters.md
Normal file
@ -0,0 +1,27 @@
|
||||
---
|
||||
title: "std::units::toMillimeters"
|
||||
excerpt: "Convert a number to millimeters from its current units."
|
||||
layout: manual
|
||||
---
|
||||
|
||||
Convert a number to millimeters from its current units.
|
||||
|
||||
|
||||
|
||||
```kcl
|
||||
units::toMillimeters(@num: number(mm)): number(mm)
|
||||
```
|
||||
|
||||
|
||||
### Arguments
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
|----------|------|-------------|----------|
|
||||
| `num` | `number(mm)` | | Yes |
|
||||
|
||||
### Returns
|
||||
|
||||
`number(mm)`
|
||||
|
||||
|
||||
|
44
docs/kcl-std/functions/std-units-toRadians.md
Normal file
44
docs/kcl-std/functions/std-units-toRadians.md
Normal file
File diff suppressed because one or more lines are too long
27
docs/kcl-std/functions/std-units-toYards.md
Normal file
27
docs/kcl-std/functions/std-units-toYards.md
Normal file
@ -0,0 +1,27 @@
|
||||
---
|
||||
title: "std::units::toYards"
|
||||
excerpt: "Converts a number to yards from its current units."
|
||||
layout: manual
|
||||
---
|
||||
|
||||
Converts a number to yards from its current units.
|
||||
|
||||
|
||||
|
||||
```kcl
|
||||
units::toYards(@num: number(yd)): number(yd)
|
||||
```
|
||||
|
||||
|
||||
### Arguments
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
|----------|------|-------------|----------|
|
||||
| `num` | `number(yd)` | | Yes |
|
||||
|
||||
### Returns
|
||||
|
||||
`number(yd)`
|
||||
|
||||
|
||||
|
Reference in New Issue
Block a user