Merge pull request #4 from hamiltonkibbe/master

Many fixes in parsing, rendering and new features

4 files changed, 101 insertions, 0 deletions

diff --git a/doc/source/documentation/excellon.rst b/doc/source/documentation/excellon.rst
new file mode 100644
index 0000000..7ac3b39
--- /dev/null
+++ b/doc/source/documentation/excellon.rst
@@ -0,0 +1,42 @@
+:mod:`excellon` --- Excellon file handling
+==============================================
+
+.. module:: excellon
+   :synopsis: Functions and classes for handling Excellon files
+.. sectionauthor:: Hamilton Kibbe <ham@hamiltonkib.be>
+
+
+The Excellon format is the most common format for exporting PCB drill
+information. The Excellon format is used to program CNC drilling macines for
+drilling holes in PCBs. As such, excellon files are sometimes refererred to as
+NC-drill files.  The Excellon format reference is available 
+`here <http://www.excellon.com/manuals/program.htm>`_. The :mod:`excellon`
+submodule implements calsses to read and write excellon files without having
+to know the precise details of the format.
+
+The :mod:`excellon` submodule's :func:`read` function serves as a
+simple interface for parsing excellon files.  The :class:`ExcellonFile` class
+stores all the information contained in an Excellon file allowing the file to
+be analyzed, modified, and updated. The :class:`ExcellonParser` class is used
+in the background for parsing RS-274X files.
+
+.. _excellon-contents:
+
+Functions
+---------
+The :mod:`excellon` module defines the following functions:
+
+.. autofunction:: gerber.excellon.read
+    
+
+Classes
+-------
+The :mod:`excellon` module defines the following classes:
+
+.. autoclass:: gerber.excellon.ExcellonFile
+    :members:
+    
+
+.. autoclass:: gerber.excellon.ExcellonParser
+    :members:
+    
\ No newline at end of file
diff --git a/doc/source/documentation/index.rst b/doc/source/documentation/index.rst
new file mode 100644
index 0000000..3d8241a
--- /dev/null
+++ b/doc/source/documentation/index.rst
@@ -0,0 +1,11 @@
+Gerber Tools Reference
+======================
+
+.. toctree::
+    :maxdepth: 2
+
+    Gerber (RS-274X) Files <rs274x>
+    Excellon Files <excellon>
+    Rendering <render>
+    
+
diff --git a/doc/source/documentation/render.rst b/doc/source/documentation/render.rst
new file mode 100644
index 0000000..324ef71
--- /dev/null
+++ b/doc/source/documentation/render.rst
@@ -0,0 +1,11 @@
+:mod:`render` --- Gerber file Rendering
+==============================================
+
+.. module:: render
+   :synopsis: Functions and classes for handling Excellon files
+.. sectionauthor:: Hamilton Kibbe <ham@hamiltonkib.be>
+
+Render Module
+-------------
+.. automodule:: gerber.render.render
+    :members:
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