Add subtitle to docs and fix primitive type links (#6724)

Signed-off-by: Nick Cameron <nrc@ncameron.org>
This commit is contained in:
Nick Cameron
2025-05-07 10:33:23 +12:00
committed by GitHub
parent cc904d258b
commit 134ec63610
143 changed files with 811 additions and 656 deletions

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -1,15 +1,16 @@
--- ---
title: "std::END" title: "END"
subtitle: "Constant in prelude"
excerpt: "Identifies the ending face of an extrusion. I.e., the new face created by an extrusion." excerpt: "Identifies the ending face of an extrusion. I.e., the new face created by an extrusion."
layout: manual layout: manual
--- ---
Identifies the ending face of an extrusion. I.e., the new face created by an extrusion. Identifies the ending face of an extrusion. I.e., the new face created by an extrusion.
```kcl ```kcl
std::END: string = 'end' END: string = 'end'
``` ```

View File

@ -1,15 +1,16 @@
--- ---
title: "std::START" title: "START"
subtitle: "Constant in prelude"
excerpt: "Identifies the starting face of an extrusion. I.e., the face which is extruded." excerpt: "Identifies the starting face of an extrusion. I.e., the face which is extruded."
layout: manual layout: manual
--- ---
Identifies the starting face of an extrusion. I.e., the face which is extruded. Identifies the starting face of an extrusion. I.e., the face which is extruded.
```kcl ```kcl
std::START: string = 'start' START: string = 'start'
``` ```

View File

@ -1,15 +1,16 @@
--- ---
title: "std::X" title: "X"
subtitle: "Constant in prelude"
excerpt: "" excerpt: ""
layout: manual layout: manual
--- ---
```kcl ```kcl
std::X X
``` ```

View File

@ -1,15 +1,16 @@
--- ---
title: "std::XY" title: "XY"
subtitle: "Constant in prelude"
excerpt: "" excerpt: ""
layout: manual layout: manual
--- ---
```kcl ```kcl
std::XY XY
``` ```

View File

@ -1,15 +1,16 @@
--- ---
title: "std::XZ" title: "XZ"
subtitle: "Constant in prelude"
excerpt: "" excerpt: ""
layout: manual layout: manual
--- ---
```kcl ```kcl
std::XZ XZ
``` ```

View File

@ -1,15 +1,16 @@
--- ---
title: "std::Y" title: "Y"
subtitle: "Constant in prelude"
excerpt: "" excerpt: ""
layout: manual layout: manual
--- ---
```kcl ```kcl
std::Y Y
``` ```

View File

@ -1,15 +1,16 @@
--- ---
title: "std::YZ" title: "YZ"
subtitle: "Constant in prelude"
excerpt: "" excerpt: ""
layout: manual layout: manual
--- ---
```kcl ```kcl
std::YZ YZ
``` ```

View File

@ -1,15 +1,16 @@
--- ---
title: "std::Z" title: "Z"
subtitle: "Constant in prelude"
excerpt: "" excerpt: ""
layout: manual layout: manual
--- ---
```kcl ```kcl
std::Z Z
``` ```

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -1,15 +1,16 @@
--- ---
title: "std::turns::HALF_TURN" title: "turns::HALF_TURN"
subtitle: "Constant in turns"
excerpt: "" excerpt: ""
layout: manual layout: manual
--- ---
```kcl ```kcl
std::turns::HALF_TURN: number(deg) = 180deg turns::HALF_TURN: number(deg) = 180deg
``` ```

View File

@ -1,15 +1,16 @@
--- ---
title: "std::turns::QUARTER_TURN" title: "turns::QUARTER_TURN"
subtitle: "Constant in turns"
excerpt: "" excerpt: ""
layout: manual layout: manual
--- ---
```kcl ```kcl
std::turns::QUARTER_TURN: number(deg) = 90deg turns::QUARTER_TURN: number(deg) = 90deg
``` ```

View File

@ -1,15 +1,16 @@
--- ---
title: "std::turns::THREE_QUARTER_TURN" title: "turns::THREE_QUARTER_TURN"
subtitle: "Constant in turns"
excerpt: "" excerpt: ""
layout: manual layout: manual
--- ---
```kcl ```kcl
std::turns::THREE_QUARTER_TURN: number(deg) = 270deg turns::THREE_QUARTER_TURN: number(deg) = 270deg
``` ```

View File

@ -1,15 +1,16 @@
--- ---
title: "std::turns::ZERO" title: "turns::ZERO"
subtitle: "Constant in turns"
excerpt: "" excerpt: ""
layout: manual layout: manual
--- ---
```kcl ```kcl
std::turns::ZERO: number = 0 turns::ZERO: number = 0
``` ```

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -1,17 +1,18 @@
--- ---
title: "std::math::atan" title: "atan"
subtitle: "Function in math"
excerpt: "Compute the arctangent of a number." excerpt: "Compute the arctangent of a number."
layout: manual layout: manual
--- ---
Compute the arctangent of a number. Compute the arctangent of a number.
Consider using `atan2()` instead for the true inverse of tangent.
```kcl ```kcl
atan(@num: number(_)): number(rad) atan(@num: number(_)): number(rad)
``` ```
Consider using `atan2()` instead for the true inverse of tangent.
### Arguments ### Arguments
| Name | Type | Description | Required | | Name | Type | Description | Required |

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -1,17 +1,18 @@
--- ---
title: "std::units::toCentimeters" title: "units::toCentimeters"
subtitle: "Function in units"
excerpt: "Convert a number to centimeters from its current units." excerpt: "Convert a number to centimeters from its current units."
layout: manual layout: manual
--- ---
Convert a number to centimeters from its current units. Convert a number to centimeters from its current units.
```kcl ```kcl
units::toCentimeters(@num: number(cm)): number(cm) units::toCentimeters(@num: number(cm)): number(cm)
``` ```
### Arguments ### Arguments
| Name | Type | Description | Required | | Name | Type | Description | Required |

File diff suppressed because one or more lines are too long

View File

@ -1,17 +1,18 @@
--- ---
title: "std::units::toFeet" title: "units::toFeet"
subtitle: "Function in units"
excerpt: "Convert a number to feet from its current units." excerpt: "Convert a number to feet from its current units."
layout: manual layout: manual
--- ---
Convert a number to feet from its current units. Convert a number to feet from its current units.
```kcl ```kcl
units::toFeet(@num: number(ft)): number(ft) units::toFeet(@num: number(ft)): number(ft)
``` ```
### Arguments ### Arguments
| Name | Type | Description | Required | | Name | Type | Description | Required |

View File

@ -1,17 +1,18 @@
--- ---
title: "std::units::toInches" title: "units::toInches"
subtitle: "Function in units"
excerpt: "Convert a number to inches from its current units." excerpt: "Convert a number to inches from its current units."
layout: manual layout: manual
--- ---
Convert a number to inches from its current units. Convert a number to inches from its current units.
```kcl ```kcl
units::toInches(@num: number(in)): number(in) units::toInches(@num: number(in)): number(in)
``` ```
### Arguments ### Arguments
| Name | Type | Description | Required | | Name | Type | Description | Required |

View File

@ -1,17 +1,18 @@
--- ---
title: "std::units::toMeters" title: "units::toMeters"
subtitle: "Function in units"
excerpt: "Convert a number to meters from its current units." excerpt: "Convert a number to meters from its current units."
layout: manual layout: manual
--- ---
Convert a number to meters from its current units. Convert a number to meters from its current units.
```kcl ```kcl
units::toMeters(@num: number(m)): number(m) units::toMeters(@num: number(m)): number(m)
``` ```
### Arguments ### Arguments
| Name | Type | Description | Required | | Name | Type | Description | Required |

View File

@ -1,17 +1,18 @@
--- ---
title: "std::units::toMillimeters" title: "units::toMillimeters"
subtitle: "Function in units"
excerpt: "Convert a number to millimeters from its current units." excerpt: "Convert a number to millimeters from its current units."
layout: manual layout: manual
--- ---
Convert a number to millimeters from its current units. Convert a number to millimeters from its current units.
```kcl ```kcl
units::toMillimeters(@num: number(mm)): number(mm) units::toMillimeters(@num: number(mm)): number(mm)
``` ```
### Arguments ### Arguments
| Name | Type | Description | Required | | Name | Type | Description | Required |

File diff suppressed because one or more lines are too long

View File

@ -1,17 +1,18 @@
--- ---
title: "std::units::toYards" title: "units::toYards"
subtitle: "Function in units"
excerpt: "Converts a number to yards from its current units." excerpt: "Converts a number to yards from its current units."
layout: manual layout: manual
--- ---
Converts a number to yards from its current units. Converts a number to yards from its current units.
```kcl ```kcl
units::toYards(@num: number(yd)): number(yd) units::toYards(@num: number(yd)): number(yd)
``` ```
### Arguments ### Arguments
| Name | Type | Description | Required | | Name | Type | Description | Required |

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -138,12 +138,12 @@ layout: manual
See also the [types overview](/docs/kcl-lang/types) See also the [types overview](/docs/kcl-lang/types)
* [**Primitive types**](/docs/kcl-std/modules/Primitive types) * [**Primitive types**](/docs/kcl-lang/types)
* [`End`](/docs/kcl-std/types#End) * [`End`](/docs/kcl-lang/types#End)
* [`ImportedGeometry`](/docs/kcl-std/types#ImportedGeometry) * [`ImportedGeometry`](/docs/kcl-lang/types#ImportedGeometry)
* [`Start`](/docs/kcl-std/types#Start) * [`Start`](/docs/kcl-lang/types#Start)
* [`TagDeclarator`](/docs/kcl-std/types#TagDeclarator) * [`TagDeclarator`](/docs/kcl-lang/types#TagDeclarator)
* [`TagIdentifier`](/docs/kcl-std/types#TagIdentifier) * [`TagIdentifier`](/docs/kcl-lang/types#TagIdentifier)
* [`any`](/docs/kcl-std/types/std-types-any) * [`any`](/docs/kcl-std/types/std-types-any)
* [`bool`](/docs/kcl-std/types/std-types-bool) * [`bool`](/docs/kcl-std/types/std-types-bool)
* [`number`](/docs/kcl-std/types/std-types-number) * [`number`](/docs/kcl-std/types/std-types-number)

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -1,13 +1,12 @@
--- ---
title: "std::math::legAngX" title: "legAngX"
subtitle: "Function in std::math"
excerpt: "Compute the angle of the given leg for x." excerpt: "Compute the angle of the given leg for x."
layout: manual layout: manual
--- ---
Compute the angle of the given leg for x. Compute the angle of the given leg for x.
```kcl ```kcl
legAngX( legAngX(
hypotenuse: number, hypotenuse: number,
@ -15,6 +14,8 @@ legAngX(
): number ): number
``` ```
### Arguments ### Arguments
| Name | Type | Description | Required | | Name | Type | Description | Required |

View File

@ -1,13 +1,12 @@
--- ---
title: "std::math::legAngY" title: "legAngY"
subtitle: "Function in std::math"
excerpt: "Compute the angle of the given leg for y." excerpt: "Compute the angle of the given leg for y."
layout: manual layout: manual
--- ---
Compute the angle of the given leg for y. Compute the angle of the given leg for y.
```kcl ```kcl
legAngY( legAngY(
hypotenuse: number, hypotenuse: number,
@ -15,6 +14,8 @@ legAngY(
): number ): number
``` ```
### Arguments ### Arguments
| Name | Type | Description | Required | | Name | Type | Description | Required |

View File

@ -1,13 +1,12 @@
--- ---
title: "std::math::legLen" title: "legLen"
subtitle: "Function in std::math"
excerpt: "Compute the length of the given leg." excerpt: "Compute the length of the given leg."
layout: manual layout: manual
--- ---
Compute the length of the given leg. Compute the length of the given leg.
```kcl ```kcl
legLen( legLen(
hypotenuse: number, hypotenuse: number,
@ -15,6 +14,8 @@ legLen(
): number ): number
``` ```
### Arguments ### Arguments
| Name | Type | Description | Required | | Name | Type | Description | Required |

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -1,5 +1,6 @@
--- ---
title: "std::array" title: "array"
subtitle: "Module in std"
excerpt: "" excerpt: ""
layout: manual layout: manual
--- ---

View File

@ -1,5 +1,6 @@
--- ---
title: "std::math" title: "math"
subtitle: "Module in std"
excerpt: "" excerpt: ""
layout: manual layout: manual
--- ---

View File

@ -1,5 +1,6 @@
--- ---
title: "std::sketch" title: "sketch"
subtitle: "Module in std"
excerpt: "" excerpt: ""
layout: manual layout: manual
--- ---

View File

@ -1,5 +1,6 @@
--- ---
title: "std::solid" title: "solid"
subtitle: "Module in std"
excerpt: "" excerpt: ""
layout: manual layout: manual
--- ---

View File

@ -1,5 +1,6 @@
--- ---
title: "std::transform" title: "transform"
subtitle: "Module in std"
excerpt: "" excerpt: ""
layout: manual layout: manual
--- ---

View File

@ -1,5 +1,6 @@
--- ---
title: "std::turns" title: "turns"
subtitle: "Module in std"
excerpt: "" excerpt: ""
layout: manual layout: manual
--- ---

View File

@ -1,5 +1,6 @@
--- ---
title: "std::types" title: "types"
subtitle: "Module in std"
excerpt: "" excerpt: ""
layout: manual layout: manual
--- ---

View File

@ -1,5 +1,6 @@
--- ---
title: "std::units" title: "units"
subtitle: "Module in std"
excerpt: "Functions for converting numbers to different units. " excerpt: "Functions for converting numbers to different units. "
layout: manual layout: manual
--- ---

View File

@ -1,5 +1,6 @@
--- ---
title: "std" title: "prelude"
subtitle: "Module in "
excerpt: "The KCL standard library " excerpt: "The KCL standard library "
layout: manual layout: manual
--- ---

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

Some files were not shown because too many files have changed in this diff Show More