summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorjaseg <git@jaseg.de>2022-02-03 01:02:45 +0100
committerjaseg <git@jaseg.de>2022-02-03 01:02:45 +0100
commitac66fd9d6b3561c1a0fb52ac2e196157bcf5f4fd (patch)
tree35af3d6f1c0e1519ccfe40363a022a6b8d1ab494 /docs
parent18b9da86601ad95aaf7f0d3e02617a1970aaf574 (diff)
downloadgerbonara-ac66fd9d6b3561c1a0fb52ac2e196157bcf5f4fd.tar.gz
gerbonara-ac66fd9d6b3561c1a0fb52ac2e196157bcf5f4fd.tar.bz2
gerbonara-ac66fd9d6b3561c1a0fb52ac2e196157bcf5f4fd.zip
More doc!
Diffstat (limited to 'docs')
-rw-r--r--docs/aperture-macros.rst3
-rw-r--r--docs/graphic-primitive-api.rst27
2 files changed, 19 insertions, 11 deletions
diff --git a/docs/aperture-macros.rst b/docs/aperture-macros.rst
index 1284c49..439b675 100644
--- a/docs/aperture-macros.rst
+++ b/docs/aperture-macros.rst
@@ -4,9 +4,6 @@ Aperture Macros
.. autoclass:: gerbonara.aperture_macros.parse.ApertureMacro
:members:
-.. autoclass:: gerbonara.aperture_macros.parse.GenericMacros
- :members:
-
.. autoclass:: gerbonara.aperture_macros.expression.Expression
:members:
diff --git a/docs/graphic-primitive-api.rst b/docs/graphic-primitive-api.rst
index d506e87..ff22b76 100644
--- a/docs/graphic-primitive-api.rst
+++ b/docs/graphic-primitive-api.rst
@@ -1,17 +1,22 @@
Graphic Primitives
==================
-.. autoclass:: gerbonara.graphic_primitives.GraphicPrimitive
- :members:
+Graphic prmitives are the core of Gerbonara's rendering interface. Individual graphic objects such as a Gerber
+:py:class:`.Region` as well as entire layers such as a :py:class:`.GerberFile` can be rendered into a list of graphic
+primitives. This rendering step resolves aperture definitions, calculates out aperture macros, converts units into a
+given target unit, and maps complex shapes to a small number of subclasses of :py:class:`.GraphicPrimitive`.
-.. autoclass:: gerbonara.graphic_primitives.Circle
- :members:
+All graphic primitives have a :py:attr:`~.GraphicPrimitive.polarity_dark` attribute. Its meaning is identical with
+:py:attr:`.GraphicObject.polarity_dark`.
-.. autoclass:: gerbonara.graphic_primitives.Obround
+.. autoclass:: gerbonara.graphic_primitives.GraphicPrimitive
:members:
-.. autoclass:: gerbonara.graphic_primitives.ArcPoly
- :members:
+The five types of Graphic Primitives
+------------------------------------
+
+Stroked lines
+~~~~~~~~~~~~~
.. autoclass:: gerbonara.graphic_primitives.Line
:members:
@@ -19,9 +24,15 @@ Graphic Primitives
.. autoclass:: gerbonara.graphic_primitives.Arc
:members:
+Filled shapes
+~~~~~~~~~~~~~
+
+.. autoclass:: gerbonara.graphic_primitives.Circle
+ :members:
+
.. autoclass:: gerbonara.graphic_primitives.Rectangle
:members:
-.. autoclass:: gerbonara.graphic_primitives.RegularPolygon
+.. autoclass:: gerbonara.graphic_primitives.ArcPoly
:members: