jaseg/gerbonara
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Doc update

Browse source
This commit is contained in:
Hamilton Kibbe 2015-02-18 23:23:53 -05:00
parent 5966d7830b
commit 4db7302485
4 changed files with 38 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/source/documentation/index.rst
View file

@ -6,5 +6,5 @@ PCB Tools Reference
Gerber (RS-274X) Files <rs274x>
Excellon Files <excellon>
Operations <operations>
Rendering <render>

24
doc/source/documentation/operations.rst Normal file
View file

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

6
doc/source/features.rst
View file

@ -3,11 +3,11 @@ Feature Suppport
Currently supported features are as follows:
============ ======== =========== ================ ====== ======= =======
============ ======== =========== ================ ====== ======= =======
File Format Parsing Rendering Unit Conversion Scale Offset Rotate
============ ======== =========== ================ ====== ======= =======
RS274-X Yes Yes Yes No No No
Excellon Yes Yes Yes No No No
RS274-X Yes Yes Yes No Yes No
Excellon Yes Yes Yes No Yes No
ODB++ No No No No No No
============ ======== =========== ================ ====== ======= =======

20
gerber/operations.py
View file

@ -27,12 +27,12 @@ def to_inch(cam_file):
Parameters
----------
cam_file : `gerber.cam.CamFile` subclass
cam_file : :class:`gerber.cam.CamFile` subclass
Gerber or Excellon file to convert
Returns
-------
gerber_file : `gerber.cam.CamFile` subclass
cam_file : :class:`gerber.cam.CamFile` subclass
A deep copy of the source file with units converted to imperial.
"""
cam_file = copy.deepcopy(cam_file)
@ -44,12 +44,12 @@ def to_metric(cam_file):
Parameters
----------
cam_file : `gerber.cam.CamFile` subclass
cam_file : :class:`gerber.cam.CamFile` subclass
Gerber or Excellon file to convert
Returns
-------
gerber_file : `gerber.cam.CamFile` subclass
cam_file : :class:`gerber.cam.CamFile` subclass
A deep copy of the source file with units converted to metric.
"""
cam_file = copy.deepcopy(cam_file)
@ -61,7 +61,7 @@ def offset(cam_file, x_offset, y_offset):
Parameters
----------
cam_file : `gerber.cam.CamFile` subclass
cam_file : :class:`gerber.cam.CamFile` subclass
Gerber or Excellon file to offset
x_offset : float
@ -72,7 +72,7 @@ def offset(cam_file, x_offset, y_offset):
Returns
-------
gerber_file : `gerber.cam.CamFile` subclass
cam_file : :class:`gerber.cam.CamFile` subclass
An offset deep copy of the source file.
"""
cam_file = copy.deepcopy(cam_file)
@ -84,7 +84,7 @@ def scale(cam_file, x_scale, y_scale):
Parameters
----------
cam_file : `gerber.cam.CamFile` subclass
cam_file : :class:`gerber.cam.CamFile` subclass
Gerber or Excellon file to scale
x_scale : float
@ -95,7 +95,7 @@ def scale(cam_file, x_scale, y_scale):
Returns
-------
gerber_file : `gerber.cam.CamFile` subclass
cam_file : :class:`gerber.cam.CamFile` subclass
An scaled deep copy of the source file.
"""
# TODO
@ -106,7 +106,7 @@ def rotate(cam_file, angle):
Parameters
----------
cam_file : `gerber.cam.CamFile` subclass
cam_file : :class:`gerber.cam.CamFile` subclass
Gerber or Excellon file to rotate
angle : float
@ -114,7 +114,7 @@ def rotate(cam_file, angle):
Returns
-------
gerber_file : `gerber.cam.CamFile` subclass
cam_file : :class:`gerber.cam.CamFile` subclass
An rotated deep copy of the source file.
"""
# TODO