summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHamilton Kibbe <hamilton.kibbe@gmail.com>2015-02-18 23:23:53 -0500
committerHamilton Kibbe <hamilton.kibbe@gmail.com>2015-02-18 23:23:53 -0500
commit4db7302485e65937463c2efe3b3c2945549ca588 (patch)
tree1d64e366bcba041b2eeb47b94159f89903a487e0 /doc
parent5966d7830bda7f37ed5ddcc1bfccb93e7f780eaa (diff)
downloadgerbonara-4db7302485e65937463c2efe3b3c2945549ca588.tar.gz
gerbonara-4db7302485e65937463c2efe3b3c2945549ca588.tar.bz2
gerbonara-4db7302485e65937463c2efe3b3c2945549ca588.zip
Doc update
Diffstat (limited to 'doc')
-rw-r--r--doc/source/documentation/index.rst2
-rw-r--r--doc/source/documentation/operations.rst24
-rw-r--r--doc/source/features.rst6
3 files changed, 28 insertions, 4 deletions
diff --git a/doc/source/documentation/index.rst b/doc/source/documentation/index.rst
index 28ecb99..dec83f9 100644
--- a/doc/source/documentation/index.rst
+++ b/doc/source/documentation/index.rst
@@ -6,5 +6,5 @@ PCB Tools Reference
Gerber (RS-274X) Files <rs274x>
Excellon Files <excellon>
+ Operations <operations>
Rendering <render>
- \ No newline at end of file
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/features.rst b/doc/source/features.rst
index 120fdcd..67d9e2a 100644
--- a/doc/source/features.rst
+++ b/doc/source/features.rst
@@ -3,11 +3,11 @@ Feature Suppport
Currently supported features are as follows:
-============ ======== =========== ================ ====== ======= =======
+============ ======== =========== ================ ====== ======= =======
File Format Parsing Rendering Unit Conversion Scale Offset Rotate
============ ======== =========== ================ ====== ======= =======
-RS274-X Yes Yes Yes No No No
-Excellon Yes Yes Yes No No No
+RS274-X Yes Yes Yes No Yes No
+Excellon Yes Yes Yes No Yes No
ODB++ No No No No No No
============ ======== =========== ================ ====== ======= =======