diff options
author | Hamilton Kibbe <hamilton.kibbe@gmail.com> | 2015-02-18 23:23:53 -0500 |
---|---|---|
committer | Hamilton Kibbe <hamilton.kibbe@gmail.com> | 2015-02-18 23:23:53 -0500 |
commit | 4db7302485e65937463c2efe3b3c2945549ca588 (patch) | |
tree | 1d64e366bcba041b2eeb47b94159f89903a487e0 /doc/source/documentation/operations.rst | |
parent | 5966d7830bda7f37ed5ddcc1bfccb93e7f780eaa (diff) | |
download | gerbonara-4db7302485e65937463c2efe3b3c2945549ca588.tar.gz gerbonara-4db7302485e65937463c2efe3b3c2945549ca588.tar.bz2 gerbonara-4db7302485e65937463c2efe3b3c2945549ca588.zip |
Doc update
Diffstat (limited to 'doc/source/documentation/operations.rst')
-rw-r--r-- | doc/source/documentation/operations.rst | 24 |
1 files changed, 24 insertions, 0 deletions
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 + + + |