diff options
author | Hamilton Kibbe <hamilton.kibbe@gmail.com> | 2014-10-12 12:38:40 -0400 |
---|---|---|
committer | Hamilton Kibbe <hamilton.kibbe@gmail.com> | 2014-10-12 12:38:40 -0400 |
commit | 8c5c7ec8bbc8a074884ef04b566f9c0ecd6e78bb (patch) | |
tree | a9032538e4a96f11a9ec16d1c761f4d8862529a8 /doc/source/documentation/rs274x.rst | |
parent | d9018da412470053a063b7b28b5e32529fc573f6 (diff) | |
download | gerbonara-8c5c7ec8bbc8a074884ef04b566f9c0ecd6e78bb.tar.gz gerbonara-8c5c7ec8bbc8a074884ef04b566f9c0ecd6e78bb.tar.bz2 gerbonara-8c5c7ec8bbc8a074884ef04b566f9c0ecd6e78bb.zip |
update docs and example images
Diffstat (limited to 'doc/source/documentation/rs274x.rst')
-rw-r--r-- | doc/source/documentation/rs274x.rst | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/doc/source/documentation/rs274x.rst b/doc/source/documentation/rs274x.rst new file mode 100644 index 0000000..bc99519 --- /dev/null +++ b/doc/source/documentation/rs274x.rst @@ -0,0 +1,37 @@ +:mod:`rs274x` --- RS-274X file handling +============================================== + +.. module:: rs274x + :synopsis: Functions and classes for handling RS-274X files +.. sectionauthor:: Hamilton Kibbe <ham@hamiltonkib.be> + + +The RS-274X (Gerber) format is the most common format for exporting PCB +artwork. The Specification is published by Ucamco and is available +`here <http://www.ucamco.com/files/downloads/file/81/the_gerber_file_format_specification.pdf>`_. +The :mod:`rs274x` submodule implements calsses to read and write +RS-274X files without having to know the precise details of the format. + +The :mod:`rs274x` submodule's :func:`read` function serves as a +simple interface for parsing gerber files. The :class:`GerberFile` class +stores all the information contained in a gerber file allowing the file to be +analyzed, modified, and updated. The :class:`GerberParser` class is used in +the background for parsing RS-274X files. + +.. _gerber-contents: + +Functions +--------- +The :mod:`rs274x` module defines the following functions: + +.. autofunction:: gerber.rs274x.read + +Classes +------- +The :mod:`rs274x` module defines the following classes: + +.. autoclass:: gerber.rs274x.GerberFile + :members: + +.. autoclass:: gerber.rs274x.GerberParser + :members:
\ No newline at end of file |