diff options
| author | Hamilton Kibbe <hamilton.kibbe@gmail.com> | 2016-11-05 21:11:09 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-11-05 21:11:09 -0400 |
| commit | d2fe4441662435e55f2dc481bf94a2729b9d6a48 (patch) | |
| tree | dd60a0b21e1d1ca7258b9f978ce973354d96062c /doc/source/documentation | |
| parent | 318a81382e074a5897489299a58e029815d23492 (diff) | |
| parent | 5af19af190c1fb0f0c5be029d46d63e657dde4d9 (diff) | |
| download | gerbonara-d2fe4441662435e55f2dc481bf94a2729b9d6a48.tar.gz gerbonara-d2fe4441662435e55f2dc481bf94a2729b9d6a48.tar.bz2 gerbonara-d2fe4441662435e55f2dc481bf94a2729b9d6a48.zip | |
Merge pull request #3 from garretfick/merge-curtacircuitos
Merge curtacircuitos
Diffstat (limited to 'doc/source/documentation')
| -rw-r--r-- | doc/source/documentation/index.rst | 5 | ||||
| -rw-r--r-- | doc/source/documentation/operations.rst | 24 | ||||
| -rw-r--r-- | doc/source/documentation/rs274x.rst | 2 |
3 files changed, 27 insertions, 4 deletions
diff --git a/doc/source/documentation/index.rst b/doc/source/documentation/index.rst index 3d8241a..dec83f9 100644 --- a/doc/source/documentation/index.rst +++ b/doc/source/documentation/index.rst @@ -1,4 +1,4 @@ -Gerber Tools Reference +PCB Tools Reference ====================== .. toctree:: @@ -6,6 +6,5 @@ Gerber Tools Reference Gerber (RS-274X) Files <rs274x> Excellon Files <excellon> + Operations <operations> Rendering <render> - - diff --git a/doc/source/documentation/operations.rst b/doc/source/documentation/operations.rst new file mode 100644 index 0000000..6551236 --- /dev/null +++ b/doc/source/documentation/operations.rst @@ -0,0 +1,24 @@ +:mod:`operations` --- Cam File operations +========================================= + +.. module:: operations + :synopsis: Functions for modifying CAM files +.. sectionauthor:: Hamilton Kibbe <ham@hamiltonkib.be> + + +The :mod:`operations` module provides functions which modify +:class:`gerber.cam.CamFile` objects. All of the functions in this module +return a modified copy of the supplied file. + +.. _operations-contents: + +Functions +--------- +The :mod:`operations` module defines the following functions: + +.. autofunction:: gerber.operations.to_inch +.. autofunction:: gerber.operations.to_metric +.. autofunction:: gerber.operations.offset + + + diff --git a/doc/source/documentation/rs274x.rst b/doc/source/documentation/rs274x.rst index bc99519..00094d4 100644 --- a/doc/source/documentation/rs274x.rst +++ b/doc/source/documentation/rs274x.rst @@ -33,5 +33,5 @@ The :mod:`rs274x` module defines the following classes: .. autoclass:: gerber.rs274x.GerberFile :members: -.. autoclass:: gerber.rs274x.GerberParser +.. autoclass:: gerber.rs274x.GerberParser :members:
\ No newline at end of file |