mirrors/build123d
1
Fork 0
mirror of https://github.com/gumyr/build123d.git synced 2025-12-06 02:30:55 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add direct api inheritance diagram - updated install instructions

Browse source
This commit is contained in:
Roger Maitland 2022-10-29 11:29:54 -04:00
parent 8ad781db04
commit 8e30f69f46
3 changed files with 13 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/direct_api_reference.rst
View file

@ -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