From 7115dcaeed1734671b7116ba80d21250875f3428 Mon Sep 17 00:00:00 2001 From: Revar Desmera Date: Tue, 23 Apr 2019 13:02:52 -0700 Subject: [PATCH] Fixes for docs generation. --- debug.scad | 12 +++++++++++- scripts/docs_gen.py | 2 +- scripts/make_all_docs.sh | 2 +- 3 files changed, 13 insertions(+), 3 deletions(-) diff --git a/debug.scad b/debug.scad index 8224677..5629a20 100644 --- a/debug.scad +++ b/debug.scad @@ -193,6 +193,8 @@ function standard_anchors() = [ // s = Length of the arrows. // color = Color of the arrow. // flag = If true, draw the orientation flag on the arrowhead. +// Example: +// anchor_arrow(s=20); module anchor_arrow(s=10, color=[0.333,0.333,1], flag=true, $tags="anchor-arrow") { $fn=12; recolor("gray") spheroid(d=s/6) @@ -213,7 +215,7 @@ module anchor_arrow(s=10, color=[0.333,0.333,1], flag=true, $tags="anchor-arrow" // Description: // Makes the children transparent gray, while showing any // anchor arrows that may exist. -// Example: +// Example(FlatSpin): // transparent() cube(50, center=true) show_anchors(); module transparent(opacity=0.2) { show("anchor-arrow") children() show_anchors(); @@ -224,6 +226,12 @@ module transparent(opacity=0.2) { // Module: show_anchors() // Description: // Show all standard anchors for the parent object. +// Arguments: +// s = Length of anchor arrows. +// std = If true (default), show standard anchors. +// custom = If true (default), show custom anchors. +// Example(FlatSpin): +// cube(50, center=true) show_anchors(); module show_anchors(s=10, std=true, custom=true) { if (std) { for (anchor=standard_anchors()) { @@ -257,6 +265,8 @@ module show_anchors(s=10, std=true, custom=true) { // Displays X,Y,Z axis arrows in red, green, and blue respectively. // Arguments: // s = Length of the arrows. +// Examples: +// frame_ref(25); module frame_ref(s=15) { noop() { attach(RIGHT) anchor_arrow(s=s, color="red", flag=false); diff --git a/scripts/docs_gen.py b/scripts/docs_gen.py index 3109260..25c68c4 100755 --- a/scripts/docs_gen.py +++ b/scripts/docs_gen.py @@ -98,7 +98,7 @@ class ImageProcessing(object): scriptfile = "tmp_{0}.scad".format(imgfile.replace(".", "_")) - stdlibs = ["constants.scad", "math.scad", "transforms.scad", "shapes.scad", "debug.scad"] + stdlibs = ["std.scad", "debug.scad"] script = "" for lib in stdlibs: script += "include \n" % lib diff --git a/scripts/make_all_docs.sh b/scripts/make_all_docs.sh index cac43ef..8540c24 100755 --- a/scripts/make_all_docs.sh +++ b/scripts/make_all_docs.sh @@ -1,6 +1,6 @@ #!/bin/bash -PREVIEW_LIBS="constants compat transforms shapes masks paths beziers math metric_screws threading involute_gears sliders joiners linear_bearings nema_steppers wiring triangulation quaternions phillips_drive torx_drive debug" +PREVIEW_LIBS="constants compat attachments math arrays vectors matrices coords geometry triangulation quaternions convex_hull transforms primitives shapes masks paths beziers metric_screws threading involute_gears sliders joiners linear_bearings nema_steppers wiring phillips_drive torx_drive debug" dir="$(basename $PWD)" if [ "$dir" = "BOSL2" ]; then