diff --git a/.gitignore b/.gitignore index e43b0f9..0361774 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,3 @@ .DS_Store + +docgen diff --git a/.openscad_docsgen_rc b/.openscad_docsgen_rc new file mode 100644 index 0000000..71c0ba8 --- /dev/null +++ b/.openscad_docsgen_rc @@ -0,0 +1,3 @@ +TargetProfile: githubwiki +ProjectName: Metal Library +GenerateDocs: Files, TOC, Index, Topics, CheatSheet, Sidebar diff --git a/docs/.source_hashes b/docs/.source_hashes new file mode 100644 index 0000000..4618d1a --- /dev/null +++ b/docs/.source_hashes @@ -0,0 +1 @@ +metalib.scad|3979a0093760105008a8e3283ce8796093ccaba9a37aa2ff4bfcf5f9ba386c4e diff --git a/docs/images/metalib/miter_profile.png b/docs/images/metalib/miter_profile.png new file mode 100644 index 0000000..0f4c282 Binary files /dev/null and b/docs/images/metalib/miter_profile.png differ diff --git a/docs/images/metalib/miter_tubes.png b/docs/images/metalib/miter_tubes.png new file mode 100644 index 0000000..8537fe9 Binary files /dev/null and b/docs/images/metalib/miter_tubes.png differ diff --git a/docs/metalib.scad.md b/docs/metalib.scad.md new file mode 100644 index 0000000..4ab71d1 --- /dev/null +++ b/docs/metalib.scad.md @@ -0,0 +1,81 @@ +# LibFile: metalib.scad + + +To use, add the following lines to the beginning of your file: + + include ; + +## File Contents + +- [`miter_profile()`](#module-miter_profile) – Creates a miter profile +- [`miter_tubes()`](#module-miter_tubes) – Generates a sequence of mitered tubes + + +### Module: miter\_profile() + +**Synopsis:** Creates a miter profile + +**Usage:** As Module + +- miter_profile(length,height,depth); + +**Description:** + +Generates a flexible battery holder for 'n' cylindrical batteries with complex features like wire channels, screw holes, and contact points. + +**Arguments:** + +By Position | What it does +-------------------- | ------------ +`length` | Length +`height` | Height +`depth` | Depth + +**Example 1:** Simple Case + +miter\_profile() Example 1 + + include ; + miter_profile(length=200, height=30, depth=20); + +

+ +--- + +### Module: miter\_tubes() + +**Synopsis:** Generates a sequence of mitered tubes + +**Description:** + +This module generates a sequence of mitered tubes based on the provided section lengths, + with options for customizing their dimensions and unfolding their arrangement. + +**Arguments:** + +By Position | What it does +-------------------- | ------------ +`section` | An array of section lengths, each specifying the length of an individual tube. Example: `[10, 20, 30]` will create three tubes of lengths 10, 20, and 30 units respectively. +`heights` | The height of each tube. This value defines the dimension perpendicular to the tube's length and depth. +`depth` | The depth of each tube. This value defines the dimension perpendicular to the tube's length and height. +`unfold` | Determines whether the sequence of tubes should be unfolded for easier visualization or fabrication. When `true`, the tubes are laid out in a flat arrangement. Defaults to `false`. + +**Example 1:** Simple Case + +miter\_tubes() Example 1 + + include ; + miter_tubes( + sections = [800,750,800], + height = 50, + depth = 50, + start=false, + end=false, + unfold = false, + quote=true + ); + +

+ +--- +