Merge branch 'dev' of https://github.com/gumyr/build123d into dev

.github/actions/setup/action.yml

@@ -14,5 +14,4 @@ runs:
     - name: Install Requirements
       shell: bash
       run: |
-        pip install wheel mypy pytest pytest-cov pylint 
-        pip install .
+        pip install .[development]

.readthedocs.yaml

@@ -15,7 +15,14 @@ build:
 sphinx:
   configuration: docs/conf.py
 
-# Explicitly set the version of Python and its requirements
 python:
   install:
-    - requirements: docs/requirements.txt
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+
+# Explicitly set the version of Python and its requirements
+# python:
+#   install:
+#     - requirements: docs/requirements.txt

docs/direct_api_reference.rst

@@ -1,3 +1,4 @@
+
 ####################
 Direct API Reference
 ####################
@@ -52,7 +53,7 @@ supplementary functionality specific to 1D
 `~topology.Solid`) objects respectively.
 Note that a :class:`~topology.Compound` may be contain only 1D, 2D (:class:`~topology.Face`)  or 3D objects.
 
-.. inheritance-diagram:: topology
+.. inheritance-diagram:: topology.shape_core topology.zero_d topology.one_d topology.two_d topology.three_d topology.composite topology.utils
    :parts: 1
 
 .. py:module:: topology
@@ -63,6 +64,7 @@ Note that a :class:`~topology.Compound` may be contain only 1D, 2D (:class:`~top
    :special-members: __neg__
 .. autoclass:: Mixin1D
    :special-members: __matmul__, __mod__
+.. autoclass:: Mixin2D
 .. autoclass:: Mixin3D
 .. autoclass:: Shape
    :special-members: __add__, __sub__, __and__, __rmul__, __eq__, __copy__, __deepcopy__, __hash__

docs/requirements.txt

@@ -1,10 +0,0 @@
-# Defining the exact version will make sure things don't break
-sphinx==5.3.0
-sphinx_rtd_theme>=0.5.1
-docutils<0.17
-readthedocs-sphinx-search>=0.3.2
-sphinx_autodoc_typehints==1.12.0
-sphinx_copybutton
-sphinx-hoverxref
-sphinx_design
--e git+https://github.com/gumyr/build123d.git#egg=build123d

pyproject.toml

@@ -52,6 +52,45 @@ dependencies = [
 "Documentation" = "https://build123d.readthedocs.io/en/latest/index.html"
 "Bug Tracker" = "https://github.com/gumyr/build123d/issues"
 
+[project.optional-dependencies]
+# enable the optional ocp_vscode visualization package
+ocp_vscode = [
+    "ocp_vscode",
+]
+
+# development dependencies
+development = [
+    "wheel",
+    "pytest",
+    "pytest-cov",
+    "pylint",
+    "mypy",
+    "black",
+]
+
+# dependency to run the pytest benchmarks
+benchmark = [
+    "pytest-benchmark",
+]
+
+# dependencies to build the docs
+docs = [
+    "sphinx==8.1.3", # pin for stability of docs builds
+    "sphinx-design",
+    "sphinx-copybutton",
+    "sphinx-hoverxref",
+    "sphinx-rtd-theme",
+    "sphinx_autodoc_typehints",
+]
+
+# all dependencies
+all = [
+    "build123d[ocp_vscode]",
+    "build123d[development]",
+    "build123d[benchmark]",
+    "build123d[docs]",
+]
+
 [tool.setuptools.packages.find]
 where = ["src"]
 # exclude build123d._dev from wheels

src/build123d/topology/__init__.py

@@ -51,9 +51,9 @@ from .utils import (
     find_max_dimension,
 )
 from .zero_d import Vertex, topo_explore_common_vertex
-from .one_d import Edge, Wire, edges_to_wires, topo_explore_connected_edges
-from .two_d import Face, Shell, sort_wires_by_build_order
-from .three_d import Solid
+from .one_d import Edge, Wire, Mixin1D, edges_to_wires, topo_explore_connected_edges
+from .two_d import Face, Shell, Mixin2D,sort_wires_by_build_order
+from .three_d import Solid, Mixin3D
 from .composite import Compound, Curve, Sketch, Part
 
 __all__ = [