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

update docs and example images

Browse source
This commit is contained in:
Hamilton Kibbe 2014-10-12 12:38:40 -04:00
parent d9018da412
commit 8c5c7ec8bb
15 changed files with 57 additions and 109 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -4,7 +4,7 @@ Gerber Tools Reference
.. toctree::
:maxdepth: 2
Gerber (RS-274X) Files <gerber>
Gerber (RS-274X) Files <rs274x>
Excellon Files <excellon>
Rendering <render>

19
doc/source/documentation/gerber.rst → doc/source/documentation/rs274x.rst
View file

@ -1,7 +1,7 @@
:mod:`gerber` --- RS-274X file handling
:mod:`rs274x` --- RS-274X file handling
==============================================
.. module:: gerber
.. module:: rs274x
:synopsis: Functions and classes for handling RS-274X files
.. sectionauthor:: Hamilton Kibbe <ham@hamiltonkib.be>
@ -9,28 +9,29 @@
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:`gerber` submodule implements calsses to read and write
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:`gerber` submodule's :func:`read` function serves as a
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:`gerber` module defines the following functions:
The :mod:`rs274x` module defines the following functions:
.. autofunction:: gerber.gerber.read
.. autofunction:: gerber.rs274x.read
Classes
-------
The :mod:`gerber` module defines the following classes:
The :mod:`rs274x` module defines the following classes:
.. autoclass:: gerber.gerber.GerberFile
.. autoclass:: gerber.rs274x.GerberFile
:members:
.. autoclass:: gerber.gerber.GerberParser
.. autoclass:: gerber.rs274x.GerberParser
:members: