diff options
author | Hamilton Kibbe <hamilton.kibbe@gmail.com> | 2014-10-11 13:12:21 -0400 |
---|---|---|
committer | Hamilton Kibbe <hamilton.kibbe@gmail.com> | 2014-10-11 13:12:21 -0400 |
commit | 62c689be172a7a06d76fd4b69c3443f3ec053765 (patch) | |
tree | 8297ff4e0a4fd3e37d7511280d20c2d01a79ac7f /doc/source/documentation | |
parent | ae3bbff8b0849e0b49dc139396d7f8c57334a7b8 (diff) | |
download | gerbonara-62c689be172a7a06d76fd4b69c3443f3ec053765.tar.gz gerbonara-62c689be172a7a06d76fd4b69c3443f3ec053765.tar.bz2 gerbonara-62c689be172a7a06d76fd4b69c3443f3ec053765.zip |
Doc update
Diffstat (limited to 'doc/source/documentation')
-rw-r--r-- | doc/source/documentation/excellon.rst | 42 | ||||
-rw-r--r-- | doc/source/documentation/gerber.rst | 36 | ||||
-rw-r--r-- | doc/source/documentation/index.rst | 11 | ||||
-rw-r--r-- | doc/source/documentation/render.rst | 11 |
4 files changed, 100 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/gerber.rst b/doc/source/documentation/gerber.rst new file mode 100644 index 0000000..78870a9 --- /dev/null +++ b/doc/source/documentation/gerber.rst @@ -0,0 +1,36 @@ +:mod:`gerber` --- RS-274X file handling +============================================== + +.. module:: gerber + :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:`gerber` submodule implements calsses to read and write +RS-274X files without having to know the precise details of the format. + +The :mod:`gerber` 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:`gerber` module defines the following functions: + +.. autofunction:: gerber.gerber.read + +Classes +------- +The :mod:`gerber` module defines the following classes: + +.. autoclass:: gerber.gerber.GerberFile + :members: + +.. autoclass:: gerber.gerber.GerberParser + :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..110df87 --- /dev/null +++ b/doc/source/documentation/index.rst @@ -0,0 +1,11 @@ +Gerber Tools Reference +====================== + +.. toctree:: + :maxdepth: 2 + + Gerber (RS-274X) Files <gerber> + 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: |