From 4db7302485e65937463c2efe3b3c2945549ca588 Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Wed, 18 Feb 2015 23:23:53 -0500 Subject: Doc update --- doc/source/documentation/index.rst | 2 +- doc/source/documentation/operations.rst | 24 ++++++++++++++++++++++++ doc/source/features.rst | 6 +++--- 3 files changed, 28 insertions(+), 4 deletions(-) create mode 100644 doc/source/documentation/operations.rst (limited to 'doc/source') 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 Excellon Files + Operations Rendering - \ 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 + + +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 ============ ======== =========== ================ ====== ======= ======= -- cgit