From d795a58a8e83da9ac1daf68ccdfeaf7bb1b3fb73 Mon Sep 17 00:00:00 2001 From: petras Date: Thu, 22 Aug 2024 15:11:28 +0200 Subject: [PATCH 1/2] DOCS: examples --- docs/examples/__temp/other/other.rst | 5 ----- docs/examples/{__temp => }/color.rst | 0 docs/examples/{__temp => }/color/blending.py | 0 docs/examples/{__temp => }/color/blending.rst | 0 docs/examples/{__temp => }/color/colors.py | 0 docs/examples/{__temp => }/color/colors.rst | 0 docs/examples/{__temp => }/color/face_vertext_color.py | 0 docs/examples/{__temp => }/color/face_vertext_color.rst | 0 docs/examples/{__temp => }/dynamic.rst | 0 docs/examples/{__temp => }/dynamic/dynamic.py | 0 docs/examples/{__temp => }/dynamic/dynamic.rst | 0 docs/examples/{__temp => }/dynamic/dynamic_mesh.py | 0 docs/examples/{__temp => }/dynamic/dynamic_mesh.rst | 0 docs/examples/{__temp => }/dynamic/orbiting.py | 0 docs/examples/{__temp => }/dynamic/orbiting.rst | 0 docs/examples/{__temp => }/dynamic/transform.py | 0 docs/examples/{__temp => }/dynamic/transform.rst | 0 docs/examples/{__temp/other.rst => object.rst} | 4 ++-- docs/examples/{__temp => }/object/arrows.py | 0 docs/examples/{__temp => }/object/arrows.rst | 0 docs/examples/{__temp => }/object/brep.py | 0 docs/examples/{__temp => }/object/brep.rst | 0 docs/examples/{__temp => }/object/frames.py | 0 docs/examples/{__temp => }/object/frames.rst | 0 docs/examples/{__temp => }/object/geometries.py | 0 docs/examples/{__temp => }/object/geometries.rst | 0 docs/examples/{__temp => }/object/lines.py | 0 docs/examples/{__temp => }/object/lines.rst | 0 docs/examples/{__temp => }/object/mesh_display.py | 0 docs/examples/{__temp => }/object/mesh_display.rst | 0 docs/examples/{__temp => }/object/nurbs.py | 0 docs/examples/{__temp => }/object/nurbs.rst | 0 docs/examples/{__temp => }/object/pointcloud.py | 0 docs/examples/{__temp => }/object/pointcloud.rst | 0 docs/examples/{__temp => }/object/points.py | 0 docs/examples/{__temp => }/object/points.rst | 0 docs/examples/{__temp => }/object/polyline.py | 0 docs/examples/{__temp => }/object/polyline.rst | 0 docs/examples/{__temp => }/object/scale.py | 0 docs/examples/{__temp => }/object/scale.rst | 0 docs/examples/{__temp => }/object/vector.py | 0 docs/examples/{__temp => }/object/vector.rst | 0 42 files changed, 2 insertions(+), 7 deletions(-) delete mode 100644 docs/examples/__temp/other/other.rst rename docs/examples/{__temp => }/color.rst (100%) rename docs/examples/{__temp => }/color/blending.py (100%) rename docs/examples/{__temp => }/color/blending.rst (100%) rename docs/examples/{__temp => }/color/colors.py (100%) rename docs/examples/{__temp => }/color/colors.rst (100%) rename docs/examples/{__temp => }/color/face_vertext_color.py (100%) rename docs/examples/{__temp => }/color/face_vertext_color.rst (100%) rename docs/examples/{__temp => }/dynamic.rst (100%) rename docs/examples/{__temp => }/dynamic/dynamic.py (100%) rename docs/examples/{__temp => }/dynamic/dynamic.rst (100%) rename docs/examples/{__temp => }/dynamic/dynamic_mesh.py (100%) rename docs/examples/{__temp => }/dynamic/dynamic_mesh.rst (100%) rename docs/examples/{__temp => }/dynamic/orbiting.py (100%) rename docs/examples/{__temp => }/dynamic/orbiting.rst (100%) rename docs/examples/{__temp => }/dynamic/transform.py (100%) rename docs/examples/{__temp => }/dynamic/transform.rst (100%) rename docs/examples/{__temp/other.rst => object.rst} (87%) rename docs/examples/{__temp => }/object/arrows.py (100%) rename docs/examples/{__temp => }/object/arrows.rst (100%) rename docs/examples/{__temp => }/object/brep.py (100%) rename docs/examples/{__temp => }/object/brep.rst (100%) rename docs/examples/{__temp => }/object/frames.py (100%) rename docs/examples/{__temp => }/object/frames.rst (100%) rename docs/examples/{__temp => }/object/geometries.py (100%) rename docs/examples/{__temp => }/object/geometries.rst (100%) rename docs/examples/{__temp => }/object/lines.py (100%) rename docs/examples/{__temp => }/object/lines.rst (100%) rename docs/examples/{__temp => }/object/mesh_display.py (100%) rename docs/examples/{__temp => }/object/mesh_display.rst (100%) rename docs/examples/{__temp => }/object/nurbs.py (100%) rename docs/examples/{__temp => }/object/nurbs.rst (100%) rename docs/examples/{__temp => }/object/pointcloud.py (100%) rename docs/examples/{__temp => }/object/pointcloud.rst (100%) rename docs/examples/{__temp => }/object/points.py (100%) rename docs/examples/{__temp => }/object/points.rst (100%) rename docs/examples/{__temp => }/object/polyline.py (100%) rename docs/examples/{__temp => }/object/polyline.rst (100%) rename docs/examples/{__temp => }/object/scale.py (100%) rename docs/examples/{__temp => }/object/scale.rst (100%) rename docs/examples/{__temp => }/object/vector.py (100%) rename docs/examples/{__temp => }/object/vector.rst (100%) diff --git a/docs/examples/__temp/other/other.rst b/docs/examples/__temp/other/other.rst deleted file mode 100644 index 59b9d15298..0000000000 --- a/docs/examples/__temp/other/other.rst +++ /dev/null @@ -1,5 +0,0 @@ -******************************************************************************* -Other -******************************************************************************* - -Examples under construction... diff --git a/docs/examples/__temp/color.rst b/docs/examples/color.rst similarity index 100% rename from docs/examples/__temp/color.rst rename to docs/examples/color.rst diff --git a/docs/examples/__temp/color/blending.py b/docs/examples/color/blending.py similarity index 100% rename from docs/examples/__temp/color/blending.py rename to docs/examples/color/blending.py diff --git a/docs/examples/__temp/color/blending.rst b/docs/examples/color/blending.rst similarity index 100% rename from docs/examples/__temp/color/blending.rst rename to docs/examples/color/blending.rst diff --git a/docs/examples/__temp/color/colors.py b/docs/examples/color/colors.py similarity index 100% rename from docs/examples/__temp/color/colors.py rename to docs/examples/color/colors.py diff --git a/docs/examples/__temp/color/colors.rst b/docs/examples/color/colors.rst similarity index 100% rename from docs/examples/__temp/color/colors.rst rename to docs/examples/color/colors.rst diff --git a/docs/examples/__temp/color/face_vertext_color.py b/docs/examples/color/face_vertext_color.py similarity index 100% rename from docs/examples/__temp/color/face_vertext_color.py rename to docs/examples/color/face_vertext_color.py diff --git a/docs/examples/__temp/color/face_vertext_color.rst b/docs/examples/color/face_vertext_color.rst similarity index 100% rename from docs/examples/__temp/color/face_vertext_color.rst rename to docs/examples/color/face_vertext_color.rst diff --git a/docs/examples/__temp/dynamic.rst b/docs/examples/dynamic.rst similarity index 100% rename from docs/examples/__temp/dynamic.rst rename to docs/examples/dynamic.rst diff --git a/docs/examples/__temp/dynamic/dynamic.py b/docs/examples/dynamic/dynamic.py similarity index 100% rename from docs/examples/__temp/dynamic/dynamic.py rename to docs/examples/dynamic/dynamic.py diff --git a/docs/examples/__temp/dynamic/dynamic.rst b/docs/examples/dynamic/dynamic.rst similarity index 100% rename from docs/examples/__temp/dynamic/dynamic.rst rename to docs/examples/dynamic/dynamic.rst diff --git a/docs/examples/__temp/dynamic/dynamic_mesh.py b/docs/examples/dynamic/dynamic_mesh.py similarity index 100% rename from docs/examples/__temp/dynamic/dynamic_mesh.py rename to docs/examples/dynamic/dynamic_mesh.py diff --git a/docs/examples/__temp/dynamic/dynamic_mesh.rst b/docs/examples/dynamic/dynamic_mesh.rst similarity index 100% rename from docs/examples/__temp/dynamic/dynamic_mesh.rst rename to docs/examples/dynamic/dynamic_mesh.rst diff --git a/docs/examples/__temp/dynamic/orbiting.py b/docs/examples/dynamic/orbiting.py similarity index 100% rename from docs/examples/__temp/dynamic/orbiting.py rename to docs/examples/dynamic/orbiting.py diff --git a/docs/examples/__temp/dynamic/orbiting.rst b/docs/examples/dynamic/orbiting.rst similarity index 100% rename from docs/examples/__temp/dynamic/orbiting.rst rename to docs/examples/dynamic/orbiting.rst diff --git a/docs/examples/__temp/dynamic/transform.py b/docs/examples/dynamic/transform.py similarity index 100% rename from docs/examples/__temp/dynamic/transform.py rename to docs/examples/dynamic/transform.py diff --git a/docs/examples/__temp/dynamic/transform.rst b/docs/examples/dynamic/transform.rst similarity index 100% rename from docs/examples/__temp/dynamic/transform.rst rename to docs/examples/dynamic/transform.rst diff --git a/docs/examples/__temp/other.rst b/docs/examples/object.rst similarity index 87% rename from docs/examples/__temp/other.rst rename to docs/examples/object.rst index 7c55735d26..7528691488 100644 --- a/docs/examples/__temp/other.rst +++ b/docs/examples/object.rst @@ -1,9 +1,9 @@ ******************************************************************************** -Other Examples +Object Examples ******************************************************************************** .. toctree:: :maxdepth: 1 :glob: - other/** + object/** diff --git a/docs/examples/__temp/object/arrows.py b/docs/examples/object/arrows.py similarity index 100% rename from docs/examples/__temp/object/arrows.py rename to docs/examples/object/arrows.py diff --git a/docs/examples/__temp/object/arrows.rst b/docs/examples/object/arrows.rst similarity index 100% rename from docs/examples/__temp/object/arrows.rst rename to docs/examples/object/arrows.rst diff --git a/docs/examples/__temp/object/brep.py b/docs/examples/object/brep.py similarity index 100% rename from docs/examples/__temp/object/brep.py rename to docs/examples/object/brep.py diff --git a/docs/examples/__temp/object/brep.rst b/docs/examples/object/brep.rst similarity index 100% rename from docs/examples/__temp/object/brep.rst rename to docs/examples/object/brep.rst diff --git a/docs/examples/__temp/object/frames.py b/docs/examples/object/frames.py similarity index 100% rename from docs/examples/__temp/object/frames.py rename to docs/examples/object/frames.py diff --git a/docs/examples/__temp/object/frames.rst b/docs/examples/object/frames.rst similarity index 100% rename from docs/examples/__temp/object/frames.rst rename to docs/examples/object/frames.rst diff --git a/docs/examples/__temp/object/geometries.py b/docs/examples/object/geometries.py similarity index 100% rename from docs/examples/__temp/object/geometries.py rename to docs/examples/object/geometries.py diff --git a/docs/examples/__temp/object/geometries.rst b/docs/examples/object/geometries.rst similarity index 100% rename from docs/examples/__temp/object/geometries.rst rename to docs/examples/object/geometries.rst diff --git a/docs/examples/__temp/object/lines.py b/docs/examples/object/lines.py similarity index 100% rename from docs/examples/__temp/object/lines.py rename to docs/examples/object/lines.py diff --git a/docs/examples/__temp/object/lines.rst b/docs/examples/object/lines.rst similarity index 100% rename from docs/examples/__temp/object/lines.rst rename to docs/examples/object/lines.rst diff --git a/docs/examples/__temp/object/mesh_display.py b/docs/examples/object/mesh_display.py similarity index 100% rename from docs/examples/__temp/object/mesh_display.py rename to docs/examples/object/mesh_display.py diff --git a/docs/examples/__temp/object/mesh_display.rst b/docs/examples/object/mesh_display.rst similarity index 100% rename from docs/examples/__temp/object/mesh_display.rst rename to docs/examples/object/mesh_display.rst diff --git a/docs/examples/__temp/object/nurbs.py b/docs/examples/object/nurbs.py similarity index 100% rename from docs/examples/__temp/object/nurbs.py rename to docs/examples/object/nurbs.py diff --git a/docs/examples/__temp/object/nurbs.rst b/docs/examples/object/nurbs.rst similarity index 100% rename from docs/examples/__temp/object/nurbs.rst rename to docs/examples/object/nurbs.rst diff --git a/docs/examples/__temp/object/pointcloud.py b/docs/examples/object/pointcloud.py similarity index 100% rename from docs/examples/__temp/object/pointcloud.py rename to docs/examples/object/pointcloud.py diff --git a/docs/examples/__temp/object/pointcloud.rst b/docs/examples/object/pointcloud.rst similarity index 100% rename from docs/examples/__temp/object/pointcloud.rst rename to docs/examples/object/pointcloud.rst diff --git a/docs/examples/__temp/object/points.py b/docs/examples/object/points.py similarity index 100% rename from docs/examples/__temp/object/points.py rename to docs/examples/object/points.py diff --git a/docs/examples/__temp/object/points.rst b/docs/examples/object/points.rst similarity index 100% rename from docs/examples/__temp/object/points.rst rename to docs/examples/object/points.rst diff --git a/docs/examples/__temp/object/polyline.py b/docs/examples/object/polyline.py similarity index 100% rename from docs/examples/__temp/object/polyline.py rename to docs/examples/object/polyline.py diff --git a/docs/examples/__temp/object/polyline.rst b/docs/examples/object/polyline.rst similarity index 100% rename from docs/examples/__temp/object/polyline.rst rename to docs/examples/object/polyline.rst diff --git a/docs/examples/__temp/object/scale.py b/docs/examples/object/scale.py similarity index 100% rename from docs/examples/__temp/object/scale.py rename to docs/examples/object/scale.py diff --git a/docs/examples/__temp/object/scale.rst b/docs/examples/object/scale.rst similarity index 100% rename from docs/examples/__temp/object/scale.rst rename to docs/examples/object/scale.rst diff --git a/docs/examples/__temp/object/vector.py b/docs/examples/object/vector.py similarity index 100% rename from docs/examples/__temp/object/vector.py rename to docs/examples/object/vector.py diff --git a/docs/examples/__temp/object/vector.rst b/docs/examples/object/vector.rst similarity index 100% rename from docs/examples/__temp/object/vector.rst rename to docs/examples/object/vector.rst From 0f52959ddb81a83245c0019ecc2d5b3aeac7c21e Mon Sep 17 00:00:00 2001 From: petras Date: Thu, 22 Aug 2024 15:40:10 +0200 Subject: [PATCH 2/2] CHANGELOG --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 32344102ac..21f8e79768 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -25,6 +25,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 * Added `robot.py` example. * Added `ortho` option to view. * Added `vertical_align` and `horizontal_align` options to `Tag`. +* Added example files in the documentation. ### Changed