summaryrefslogtreecommitdiff
path: root/gerber
diff options
context:
space:
mode:
Diffstat (limited to 'gerber')
-rw-r--r--gerber/__init__.py4
-rwxr-xr-xgerber/excellon.py4
-rw-r--r--gerber/excellon_statements.py5
-rw-r--r--gerber/gerber.py4
-rw-r--r--gerber/gerber_statements.py6
-rw-r--r--gerber/render/render.py6
6 files changed, 21 insertions, 8 deletions
diff --git a/gerber/__init__.py b/gerber/__init__.py
index 4637713..fce6483 100644
--- a/gerber/__init__.py
+++ b/gerber/__init__.py
@@ -15,9 +15,11 @@
# See the License for the specific language governing permissions and
# limitations under the License.
"""
-gerber module
+Gerber Tools
============
**Gerber Tools**
+gerber-tools provides utilities for working with Gerber (RS-274X) and Excellon
+files in python.
"""
diff --git a/gerber/excellon.py b/gerber/excellon.py
index 663f791..4166de6 100755
--- a/gerber/excellon.py
+++ b/gerber/excellon.py
@@ -15,8 +15,8 @@
# See the License for the specific language governing permissions and
# limitations under the License.
"""
-Excellon module
-============
+Excellon File module
+====================
**Excellon file classes**
This module provides Excellon file classes and parsing utilities
diff --git a/gerber/excellon_statements.py b/gerber/excellon_statements.py
index 5eba12c..7300b60 100644
--- a/gerber/excellon_statements.py
+++ b/gerber/excellon_statements.py
@@ -14,7 +14,12 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
+"""
+Excellon Statements
+====================
+**Excellon file statement classes**
+"""
from .utils import parse_gerber_value, write_gerber_value, decimal_string
import re
diff --git a/gerber/gerber.py b/gerber/gerber.py
index c59d871..4ce261d 100644
--- a/gerber/gerber.py
+++ b/gerber/gerber.py
@@ -16,8 +16,8 @@
# See the License for the specific language governing permissions and
# limitations under the License.
"""
-gerber.gerber
-============
+Gerber File module
+==================
**Gerber File module**
This module provides an RS-274-X class and parser
diff --git a/gerber/gerber_statements.py b/gerber/gerber_statements.py
index 4c5133a..2caced5 100644
--- a/gerber/gerber_statements.py
+++ b/gerber/gerber_statements.py
@@ -1,9 +1,9 @@
#! /usr/bin/env python
# -*- coding: utf-8 -*-
"""
-gerber.statements
-=================
-**Gerber file statement classes**
+Gerber (RS-274X) Statements
+===========================
+**Gerber RS-274X file statement classes**
"""
from .utils import parse_gerber_value, write_gerber_value, decimal_string
diff --git a/gerber/render/render.py b/gerber/render/render.py
index db3c743..f2d23b4 100644
--- a/gerber/render/render.py
+++ b/gerber/render/render.py
@@ -15,7 +15,13 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
+"""
+Rendering
+============
+**Gerber (RS-274X) and Excellon file rendering**
+Render Gerber and Excellon files to a variety of formats.
+"""
from ..gerber_statements import (CommentStmt, UnknownStmt, EofStmt, ParamStmt,
CoordStmt, ApertureStmt, RegionModeStmt,
QuadrantModeStmt,