From 8e30f69f46983b687a7c10b2d46a8db36650a380 Mon Sep 17 00:00:00 2001 From: Roger Maitland Date: Sat, 29 Oct 2022 11:29:54 -0400 Subject: [PATCH] Add direct api inheritance diagram - updated install instructions --- docs/conf.py | 1 + docs/direct_api_reference.rst | 12 ++++++++++++ docs/installation.rst | 7 ------- 3 files changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 32c2ac8..1f2c43d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -44,6 +44,7 @@ extensions = [ "sphinx.ext.autodoc", "sphinx_autodoc_typehints", "sphinx.ext.doctest", + "sphinx.ext.inheritance_diagram", "sphinx_design", ] diff --git a/docs/direct_api_reference.rst b/docs/direct_api_reference.rst index 3f070e6..3d12e78 100644 --- a/docs/direct_api_reference.rst +++ b/docs/direct_api_reference.rst @@ -14,9 +14,20 @@ with the following major changes: .. py:module:: direct_api +The inheritance diagram for the direct api is shown below. Note that the ``Mixin1D`` +and ``Mixin3D`` classes add supplementary functionality specific to 1D +(``Edge`` and ``Wire``) and 3D (``Compound`` and ``Solid``) objects respectively. +Note that a ``Compound`` may be contain only 1D, 2D (``Face``) or 3D objects. + +.. inheritance-diagram:: direct_api + :top-classes: direct_api.Shape, direct_api.Mixin1D, direct_api,Mixin3D + :parts: 1 + ***************** Geometric Objects ***************** +The geometric classes defined by build123d are defined below. This parameters to the +CAD objects described in the following section are frequently of these types. .. autoclass:: Axis .. autoclass:: Location @@ -29,6 +40,7 @@ Geometric Objects *********** CAD Objects *********** +The CAD object classes defined by build123d are defined below. .. autoclass:: BoundBox .. autoclass:: Compound diff --git a/docs/installation.rst b/docs/installation.rst index 877d24b..e66928a 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -6,10 +6,3 @@ Install from github: .. doctest:: >>> python3 -m pip install git+https://github.com/gumyr/build123d.git#egg=build123d - -In addition, cq_warehouse and cadquery are required dependencies which will be removed in the -future. To install cq_warehouse: - -.. doctest:: - - >>> python3 -m pip install git+https://github.com/gumyr/cq_warehouse.git#egg=cq_warehouse