Doc update
This commit is contained in:
parent
ae3bbff8b0
commit
62c689be17
20 changed files with 171 additions and 15423 deletions
42
doc/source/documentation/excellon.rst
Normal file
42
doc/source/documentation/excellon.rst
Normal file
|
|
@ -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:
|
||||
|
||||
36
doc/source/documentation/gerber.rst
Normal file
36
doc/source/documentation/gerber.rst
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
:mod:`gerber` --- RS-274X file handling
|
||||
==============================================
|
||||
|
||||
.. module:: gerber
|
||||
: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:`gerber` 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
|
||||
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:
|
||||
|
||||
.. autofunction:: gerber.gerber.read
|
||||
|
||||
Classes
|
||||
-------
|
||||
The :mod:`gerber` module defines the following classes:
|
||||
|
||||
.. autoclass:: gerber.gerber.GerberFile
|
||||
:members:
|
||||
|
||||
.. autoclass:: gerber.gerber.GerberParser
|
||||
:members:
|
||||
11
doc/source/documentation/index.rst
Normal file
11
doc/source/documentation/index.rst
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
Gerber Tools Reference
|
||||
======================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
Gerber (RS-274X) Files <gerber>
|
||||
Excellon Files <excellon>
|
||||
Rendering <render>
|
||||
|
||||
|
||||
11
doc/source/documentation/render.rst
Normal file
11
doc/source/documentation/render.rst
Normal file
|
|
@ -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:
|
||||
Loading…
Add table
Add a link
Reference in a new issue