summaryrefslogtreecommitdiff
path: root/doc/source/documentation/rs274x.rst
diff options
context:
space:
mode:
authorPaulo Henrique Silva <ph.silva@gmail.com>2014-10-26 20:55:22 -0200
committerPaulo Henrique Silva <ph.silva@gmail.com>2014-10-26 20:55:22 -0200
commitd5c8d896d87e02d32d0c0758a09f051c141006f6 (patch)
tree50e2788e5dfc63db909a3613fff6934a0e80b153 /doc/source/documentation/rs274x.rst
parentd0eedf3dd7ee4fbf19f51de319e48dd964b93561 (diff)
parent4f076d7b769b0f488888d268a9a199b7545afdd7 (diff)
downloadgerbonara-d5c8d896d87e02d32d0c0758a09f051c141006f6.tar.gz
gerbonara-d5c8d896d87e02d32d0c0758a09f051c141006f6.tar.bz2
gerbonara-d5c8d896d87e02d32d0c0758a09f051c141006f6.zip
Merge pull request #4 from hamiltonkibbe/master
Many fixes in parsing, rendering and new features
Diffstat (limited to 'doc/source/documentation/rs274x.rst')
-rw-r--r--doc/source/documentation/rs274x.rst37
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