Graft pcb-tools upstream onto gerbonara tree

9 files changed, 464 insertions, 0 deletions

diff --git a/doc/source/about.rst b/doc/source/about.rst
new file mode 100644
index 0000000..85e7184
--- /dev/null
+++ b/doc/source/about.rst
@@ -0,0 +1,40 @@
+About PCB Tools
+===============
+
+
+PCB Tools provides a set of utilities for visualizing and working with PCB
+design files in a variety of formats. The design files are generally referred
+to as Gerber files. This is a generic term that may refer to
+`RS-274X (Gerber) <http://en.wikipedia.org/wiki/Gerber_format>`_,
+`ODB++ <http://en.wikipedia.org/wiki/ODB%2B%2B>`_ ,
+or `Excellon <http://en.wikipedia.org/wiki/Excellon_format>`_ files. These
+file formats are used by the CNC equipment used to manufacutre PCBs.
+
+PCB Tools currently supports the following file formats:
+
+- Gerber (RS-274X)
+- Excellon
+
+with planned support for IPC-2581, ODB++ and more.
+
+Image Rendering
+~~~~~~~~~~~~~~~
+.. image:: ../../examples/cairo_example.png
+   :alt: Rendering Example
+
+The PCB Tools module provides tools to visualize PCBs and export images in a
+variety of formats, including SVG and PNG.
+
+
+
+
+Future Plans
+~~~~~~~~~~~~
+We are working on adding the following features to PCB Tools:
+
+- Design Rules Checking
+- Editing
+- Panelization
+
+
+
diff --git a/doc/source/conf.py b/doc/source/conf.py
new file mode 100644
index 0000000..238a0b8
--- /dev/null
+++ b/doc/source/conf.py
@@ -0,0 +1,262 @@
+# -*- coding: utf-8 -*-

+#

+# Gerber Tools documentation build configuration file, created by

+# sphinx-quickstart on Sun Sep 28 18:16:46 2014.

+#

+# This file is execfile()d with the current directory set to its

+# containing dir.

+#

+# Note that not all possible configuration values are present in this

+# autogenerated file.

+#

+# All configuration values have a default; values that are commented out

+# serve to show the default.

+

+import sys

+import os

+

+# If extensions (or modules to document with autodoc) are in another directory,

+# add these directories to sys.path here. If the directory is relative to the

+# documentation root, use os.path.abspath to make it absolute, like shown here.

+sys.path.insert(0, os.path.abspath('../../'))

+

+# -- General configuration ------------------------------------------------

+

+# If your documentation needs a minimal Sphinx version, state it here.

+#needs_sphinx = '1.0'

+

+# Add any Sphinx extension module names here, as strings. They can be

+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom

+# ones.

+extensions = [

+    'sphinx.ext.autodoc',

+    'sphinx.ext.autosummary',

+    'numpydoc',

+]

+

+# Add any paths that contain templates here, relative to this directory.

+templates_path = ['_templates']

+

+# The suffix of source filenames.

+source_suffix = '.rst'

+

+# The encoding of source files.

+#source_encoding = 'utf-8-sig'

+

+# The master toctree document.

+master_doc = 'index'

+

+# General information about the project.

+project = u'PCB Tools'

+copyright = u'2014 Paulo Henrique Silva <ph.silva@gmail.com>, Hamilton Kibbe <ham@hamiltonkib.be>'

+

+# The version info for the project you're documenting, acts as replacement for

+# |version| and |release|, also used in various other places throughout the

+# built documents.

+#

+# The short X.Y version.

+version = '0.1'

+# The full version, including alpha/beta/rc tags.

+release = '0.1'

+

+# The language for content autogenerated by Sphinx. Refer to documentation

+# for a list of supported languages.

+#language = None

+

+# There are two options for replacing |today|: either, you set today to some

+# non-false value, then it is used:

+#today = ''

+# Else, today_fmt is used as the format for a strftime call.

+#today_fmt = '%B %d, %Y'

+

+# List of patterns, relative to source directory, that match files and

+# directories to ignore when looking for source files.

+exclude_patterns = []

+

+# The reST default role (used for this markup: `text`) to use for all

+# documents.

+#default_role = None

+

+# If true, '()' will be appended to :func: etc. cross-reference text.

+#add_function_parentheses = True

+

+# If true, the current module name will be prepended to all description

+# unit titles (such as .. function::).

+add_module_names = False

+

+# If true, sectionauthor and moduleauthor directives will be shown in the

+# output. They are ignored by default.

+show_authors = False

+

+# The name of the Pygments (syntax highlighting) style to use.

+pygments_style = 'sphinx'

+

+# A list of ignored prefixes for module index sorting.

+#modindex_common_prefix = []

+

+# If true, keep warnings as "system message" paragraphs in the built documents.

+#keep_warnings = False

+

+

+# -- Options for HTML output ----------------------------------------------

+

+# The theme to use for HTML and HTML Help pages.  See the documentation for

+# a list of builtin themes.

+html_theme = 'default'

+

+# Theme options are theme-specific and customize the look and feel of a theme

+# further.  For a list of options available for each theme, see the

+# documentation.

+#html_theme_options = {}

+

+# Add any paths that contain custom themes here, relative to this directory.

+#html_theme_path = []

+

+# The name for this set of Sphinx documents.  If None, it defaults to

+# "<project> v<release> documentation".

+#html_title = None

+

+# A shorter title for the navigation bar.  Default is the same as html_title.

+#html_short_title = None

+

+# The name of an image file (relative to this directory) to place at the top

+# of the sidebar.

+#html_logo = None

+

+# The name of an image file (within the static path) to use as favicon of the

+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32

+# pixels large.

+#html_favicon = None

+

+# Add any paths that contain custom static files (such as style sheets) here,

+# relative to this directory. They are copied after the builtin static files,

+# so a file named "default.css" will overwrite the builtin "default.css".

+html_static_path = ['_static']

+

+# Add any extra paths that contain custom files (such as robots.txt or

+# .htaccess) here, relative to this directory. These files are copied

+# directly to the root of the documentation.

+#html_extra_path = []

+

+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,

+# using the given strftime format.

+#html_last_updated_fmt = '%b %d, %Y'

+

+# If true, SmartyPants will be used to convert quotes and dashes to

+# typographically correct entities.

+#html_use_smartypants = True

+

+# Custom sidebar templates, maps document names to template names.

+#html_sidebars = {}

+

+# Additional templates that should be rendered to pages, maps page names to

+# template names.

+#html_additional_pages = {}

+

+# If false, no module index is generated.

+#html_domain_indices = True

+

+# If false, no index is generated.

+#html_use_index = True

+

+# If true, the index is split into individual pages for each letter.

+#html_split_index = False

+

+# If true, links to the reST sources are added to the pages.

+#html_show_sourcelink = True

+

+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.

+#html_show_sphinx = True

+

+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.

+#html_show_copyright = True

+

+# If true, an OpenSearch description file will be output, and all pages will

+# contain a <link> tag referring to it.  The value of this option must be the

+# base URL from which the finished HTML is served.

+#html_use_opensearch = ''

+

+# This is the file name suffix for HTML files (e.g. ".xhtml").

+#html_file_suffix = None

+

+# Output file base name for HTML help builder.

+htmlhelp_basename = 'PCBToolsdoc'

+

+

+# -- Options for LaTeX output ---------------------------------------------

+

+latex_elements = {

+# The paper size ('letterpaper' or 'a4paper').

+#'papersize': 'letterpaper',

+

+# The font size ('10pt', '11pt' or '12pt').

+#'pointsize': '10pt',

+

+# Additional stuff for the LaTeX preamble.

+#'preamble': '',

+}

+

+# Grouping the document tree into LaTeX files. List of tuples

+# (source start file, target name, title,

+#  author, documentclass [howto, manual, or own class]).

+latex_documents = [

+  ('index', 'PCBTools.tex', u'PCB Tools Documentation',

+   u'Hamilton Kibbe', 'manual'),

+]

+

+# The name of an image file (relative to this directory) to place at the top of

+# the title page.

+#latex_logo = None

+

+# For "manual" documents, if this is true, then toplevel headings are parts,

+# not chapters.

+#latex_use_parts = False

+

+# If true, show page references after internal links.

+#latex_show_pagerefs = False

+

+# If true, show URL addresses after external links.

+#latex_show_urls = False

+

+# Documents to append as an appendix to all manuals.

+#latex_appendices = []

+

+# If false, no module index is generated.

+#latex_domain_indices = True

+

+

+# -- Options for manual page output ---------------------------------------

+

+# One entry per manual page. List of tuples

+# (source start file, name, description, authors, manual section).

+man_pages = [

+    ('index', 'pcbtools', u'PCB Tools Documentation',

+     [u'Hamilton Kibbe'], 1)

+]

+

+# If true, show URL addresses after external links.

+#man_show_urls = False

+

+

+# -- Options for Texinfo output -------------------------------------------

+

+# Grouping the document tree into Texinfo files. List of tuples

+# (source start file, target name, title, author,

+#  dir menu entry, description, category)

+texinfo_documents = [

+  ('index', 'PCBTools', u'PCB Tools Documentation',

+   u'Hamilton Kibbe', 'PCBTools', 'Tools for working with PCB CAM files.',

+   'Miscellaneous'),

+]

+

+# Documents to append as an appendix to all manuals.

+#texinfo_appendices = []

+

+# If false, no module index is generated.

+#texinfo_domain_indices = True

+

+# How to display URL addresses: 'footnote', 'no', or 'inline'.

+#texinfo_show_urls = 'footnote'

+

+# If true, do not generate a @detailmenu in the "Top" node's menu.

+#texinfo_no_detailmenu = False

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..dec83f9
--- /dev/null
+++ b/doc/source/documentation/index.rst
@@ -0,0 +1,10 @@
+PCB Tools Reference
+======================
+
+.. toctree::
+    :maxdepth: 2
+
+    Gerber (RS-274X) Files <rs274x>
+    Excellon Files <excellon>
+    Operations <operations>
+    Rendering <render>
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 <ham@hamiltonkib.be>
+
+
+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/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..00094d4
--- /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
diff --git a/doc/source/features.rst b/doc/source/features.rst
new file mode 100644
index 0000000..67d9e2a
--- /dev/null
+++ b/doc/source/features.rst
@@ -0,0 +1,14 @@
+Feature Suppport
+================
+
+Currently supported features are as follows:
+
+============  ========  ===========  ================  ======  =======  =======
+File Format   Parsing    Rendering   Unit Conversion   Scale   Offset   Rotate
+============  ========  ===========  ================  ======  =======  =======
+RS274-X       Yes       Yes          Yes               No      Yes      No
+Excellon      Yes       Yes          Yes               No      Yes      No
+ODB++         No        No           No                No      No       No
+============  ========  ===========  ================  ======  =======  =======
+
+
diff --git a/doc/source/index.rst b/doc/source/index.rst
new file mode 100644
index 0000000..c96ff8a
--- /dev/null
+++ b/doc/source/index.rst
@@ -0,0 +1,24 @@
+.. PCB-tools documentation master file, created by

+   sphinx-quickstart on Sun Sep 28 18:16:46 2014.

+   You can adapt this file completely to your liking, but it should at least

+   contain the root `toctree` directive.

+

+PCB-Tools

+========================================

+

+Contents:

+

+.. toctree::

+    :maxdepth: 1

+    

+    about

+    features

+    documentation/index

+

+Indices and tables

+==================

+

+* :ref:`genindex`

+* :ref:`modindex`

+* :ref:`search`

+