jaseg/gerbonara
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

More doc

Browse source
This commit is contained in:
jaseg 2022-02-03 19:57:16 +01:00
parent ac66fd9d6b
commit eaf4f21ce6
24 changed files with 543 additions and 108 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/file-api.rst
View file

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

15
docs/utilities.rst
View file

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