doc update

This commit is contained in:
Hamilton Kibbe 2014-10-09 22:10:28 -04:00
parent bf9f9451f5
commit f2f411493e
7 changed files with 31 additions and 12 deletions

View file

@ -20,12 +20,18 @@ Contents:
.. automodule:: gerber.excellon
:members:
.. automodule:: gerber.render.render
:members:
.. automodule:: gerber.gerber_statements
:members:
.. automodule:: gerber.excellon_statements
:members:
.. automodule:: gerber.cnc
:members:
.. automodule:: gerber.statements
:members:
.. automodule:: gerber.utils
:members:

View file

@ -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.
"""

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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,