docs: add captions to figures

sethfischer · Jun 28, 2023 · d4e45f1 · d4e45f1
1 parent b3ac8eb
commit d4e45f1
Show file tree

Hide file tree

Showing 10 changed files with 85 additions and 263 deletions.
diff --git a/docs/din-rail-assemblies/control.rst b/docs/din-rail-assemblies/control.rst
@@ -12,11 +12,15 @@
 Control electronics
 ===================
 
-.. cadquery-vtk::
+.. cadquery:vtk::
 
-    from osr_mechanical.electronics import ControlElectronics
+    Control electronics DIN rail assembly.
 
-    result = ControlElectronics().cq_object
+    .. code-block:: python
+
+        from osr_mechanical.electronics import ControlElectronics
+
+        result = ControlElectronics().cq_object
 
 
 Bill of materials

diff --git a/docs/din-rail-assemblies/index.rst b/docs/din-rail-assemblies/index.rst
@@ -12,11 +12,15 @@
 DIN rail assemblies
 ===================
 
-.. cadquery-vtk::
+.. cadquery:vtk::
 
-    from osr_mechanical.electronics import ControlElectronics
+    DIN rail assemblies.
 
-    result = ControlElectronics().cq_object
+    .. code-block:: python
+
+        from osr_mechanical.electronics import ControlElectronics
+
+        result = ControlElectronics().cq_object
 
 
 .. toctree::

diff --git a/docs/frame/index.rst b/docs/frame/index.rst
@@ -12,11 +12,15 @@
 Frame
 =====
 
-.. cadquery-vtk::
+.. cadquery:vtk::
 
-    from osr_mechanical.frame.final import Frame
+    Frame assembly constructed from 2020 V-slot extrusion.
 
-    result = Frame().cq_object
+    .. code-block:: python
+
+        from osr_mechanical.frame.final import Frame
+
+        result = Frame().cq_object
 
 
 .. toctree::

diff --git a/docs/frame/side-port.rst b/docs/frame/side-port.rst
@@ -11,12 +11,16 @@ Frame side (port)
 =================
 
 
-.. cadquery-vtk::
+.. cadquery:vtk::
 
-    from osr_mechanical.frame.side import FrameSide
-    from osr_mechanical.bom.parts import port
+    Frame port sub-assembly.
 
-    result = FrameSide(port).cq_object
+    .. code-block:: python
+
+        from osr_mechanical.frame.side import FrameSide
+        from osr_mechanical.bom.parts import port
+
+        result = FrameSide(port).cq_object
 
 
 Bill of materials

diff --git a/docs/frame/side-starboard.rst b/docs/frame/side-starboard.rst
@@ -11,12 +11,16 @@ Frame side (starboard)
 ======================
 
 
-.. cadquery-vtk::
+.. cadquery:vtk::
 
-    from osr_mechanical.frame.side import FrameSide
-    from osr_mechanical.bom.parts import starboard
+    Frame starboard sub-assembly.
 
-    result = FrameSide(starboard).cq_object
+    .. code-block:: python
+
+        from osr_mechanical.frame.side import FrameSide
+        from osr_mechanical.bom.parts import starboard
+
+        result = FrameSide(starboard).cq_object
 
 
 Bill of materials

diff --git a/docs/index.rst b/docs/index.rst
@@ -32,11 +32,15 @@ sethfischer-rover
             :octicon:`mark-github` Star on GitHub
 
 
-.. cadquery-vtk::
+.. cadquery:vtk::
 
-    from osr_mechanical.final import FinalAssembly
+    Final assembly of sethfischer-rover.
 
-    result = FinalAssembly().cq_object
+    .. code-block:: python
+
+        from osr_mechanical.final import FinalAssembly
+
+        result = FinalAssembly().cq_object
 
 
 Specifications

diff --git a/docs/jigs/end-tap-jig-2020.rst b/docs/jigs/end-tap-jig-2020.rst
@@ -6,11 +6,15 @@ End tap jig 2020
 
 End tap jig for 2020 aluminium V-slot extrusion.
 
-.. cadquery-vtk::
+.. cadquery:vtk::
 
-    from osr_mechanical.jigs.vslot import EndTapJig
+    End tap jig for 2020 V-slot extrusion.
 
-    result = EndTapJig().cq_object
+    .. code-block:: python
+
+        from osr_mechanical.jigs.vslot import EndTapJig
+
+        result = EndTapJig().cq_object
 
 
 Bill of materials
@@ -36,23 +40,30 @@ Jig body
     :supports: no
 
 
-.. cadquery-vtk::
+.. cadquery:vtk::
+    :color: 0.85, 0.45, 0.01, 1
 
-    from osr_mechanical.jigs.vslot import EndTapJig
+    3D printed body for 2020 V-slot end tap jig.
+
+    .. code-block:: python
+
+        from osr_mechanical.jigs.vslot import EndTapJig
 
-    jig = EndTapJig()
-    result = jig.cq_part("2020_end_tap_jig__body")
+        jig = EndTapJig()
+        result = jig.cq_part("2020_end_tap_jig__body")
 
 
 .. dropdown:: Print orientation
 
     Print standing on end with T-slot aperture facing up.
 
-    .. cadquery-svg::
+    .. cadquery:svg::
 
-        from osr_mechanical.jigs.vslot import EndTapJig
+        Print orientation for 2020 V-slot end tag jig body.
 
-        jig = EndTapJig()
-        result = jig.cq_part("2020_end_tap_jig__body")
+        .. code-block:: python
+
+            from osr_mechanical.jigs.vslot import EndTapJig
 
-        show_object(result)
+            jig = EndTapJig()
+            result = jig.cq_part("2020_end_tap_jig__body")
diff --git a/docs/rocker-axle.rst b/docs/rocker-axle.rst
@@ -12,11 +12,15 @@
 Rocker axle
 ===========
 
-.. cadquery-vtk::
+.. cadquery:vtk::
 
-    from osr_mechanical.rocker_axle import RockerAxle
+    Rocker axle sub-assembly.
 
-    result = RockerAxle().cq_object
+    .. code-block:: python
+
+        from osr_mechanical.rocker_axle import RockerAxle
+
+        result = RockerAxle().cq_object
 
 
 Bill of materials