summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorHamilton Kibbe <ham@hamiltonkib.be>2014-10-13 12:38:57 -0400
committerHamilton Kibbe <ham@hamiltonkib.be>2014-10-13 12:38:57 -0400
commit6adcdbae5fc06959203761616e778ba4594475cc (patch)
tree1b878d7fe63645899a0d631849596b70bd002b07 /doc/source
parent152fca07685d6f96f5e5bad723f1f62de99d8b7d (diff)
parent8c5c7ec8bbc8a074884ef04b566f9c0ecd6e78bb (diff)
downloadgerbonara-6adcdbae5fc06959203761616e778ba4594475cc.tar.gz
gerbonara-6adcdbae5fc06959203761616e778ba4594475cc.tar.bz2
gerbonara-6adcdbae5fc06959203761616e778ba4594475cc.zip
Merge branch 'master' of https://github.com/hamiltonkibbe/gerber-tools
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/conf.py3
-rw-r--r--doc/source/documentation/excellon.rst42
-rw-r--r--doc/source/documentation/index.rst11
-rw-r--r--doc/source/documentation/render.rst11
-rw-r--r--doc/source/documentation/rs274x.rst37
-rw-r--r--doc/source/index.rst29
-rw-r--r--doc/source/intro.rst19
7 files changed, 126 insertions, 26 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 0a3cfc1..a118546 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -30,6 +30,7 @@ sys.path.insert(0, os.path.abspath('../../'))
# ones.
extensions = [
'sphinx.ext.autodoc',
+ 'sphinx.ext.autosummary',
'numpydoc',
]
@@ -85,7 +86,7 @@ exclude_patterns = []
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
-#show_authors = False
+show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
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
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 763d04a..aec8b48 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -3,37 +3,16 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
-Welcome to Gerber Tools's documentation!
+Gerber-Tools!
========================================
Contents:
.. toctree::
- :maxdepth: 2
-
-.. automodule:: gerber
- :members:
-
-.. automodule:: gerber.gerber
- :members:
-
-.. automodule:: gerber.excellon
- :members:
-
-.. automodule:: gerber.render.render
- :members:
-
-.. automodule:: gerber.gerber_statements
- :members:
-
-.. automodule:: gerber.excellon_statements
- :members:
-
-.. automodule:: gerber.cnc
- :members:
+ :maxdepth: 1
-.. automodule:: gerber.utils
- :members:
+ intro
+ documentation/index
Indices and tables
==================
diff --git a/doc/source/intro.rst b/doc/source/intro.rst
new file mode 100644
index 0000000..1982fc8
--- /dev/null
+++ b/doc/source/intro.rst
@@ -0,0 +1,19 @@
+Gerber Tools Intro
+==================
+
+PCB CAM (Gerber) Files
+------------
+
+PCB design files (artwork) are most often stored in `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.
+
+
+Gerber-Tools
+------------
+
+The gerber-tools module provides tools for working with and rendering Gerber
+and Excellon files.
+
+