diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/file-api.rst | 6 | ||||
| -rw-r--r-- | docs/utilities.rst | 15 |
2 files changed, 21 insertions, 0 deletions
diff --git a/docs/file-api.rst b/docs/file-api.rst index ed23672..ba472d4 100644 --- a/docs/file-api.rst +++ b/docs/file-api.rst @@ -10,9 +10,15 @@ either a :py:class:`.GerberFile` or an :py:class:`.ExcellonFile`) is represented :py:class:`.LayerStack` contains logic to automatcally recognize a wide variety of CAD tools from file name and syntactic hints, and can automatically match all files in a folder to their appropriate layers. +:py:class:`.CamFile` is the common base class for all layer types. + + .. autoclass:: gerbonara.layers.LayerStack :members: +.. autoclass:: gerbonara.cam.CamFile + :members: + .. autoclass:: gerbonara.rs274x.GerberFile :members: diff --git a/docs/utilities.rst b/docs/utilities.rst index 80ce5ec..5e75df5 100644 --- a/docs/utilities.rst +++ b/docs/utilities.rst @@ -1,8 +1,23 @@ Utilities ========= +Physical units +~~~~~~~~~~~~~~ + +Gerbonara tracks length units using the :py:class:`.LengthUnit` class. :py:class:`.LengthUnit` contains a number of +conventient conversion functions. Everywhere where Gerbonara accepts units as a method argument, it automatically +converts a string ``'mm'`` or ``'inch'`` to the corresponding :py:class:`.LengthUnit`. + .. autoclass:: gerbonara.utils.LengthUnit :members: +Format settings +~~~~~~~~~~~~~~~ + +When reading or writing Gerber or Excellon, Gerbonara stores information about file format options such as zero +suppression or number of decimal places in a :py:class:`.FileSettings` instance. When you are writing a Gerber file, +Gerbonara picks reasonable defaults, but allows you to specify your own :py:class:`.FileSettings` to override these +defaults. + .. autoclass:: gerbonara.cam.FileSettings :members: |