diff options
author | jaseg <git@jaseg.de> | 2022-02-01 22:08:54 +0100 |
---|---|---|
committer | jaseg <git@jaseg.de> | 2022-02-01 22:08:54 +0100 |
commit | 7473e471dc69d09a35bb0762549cc4f3ab8b04b3 (patch) | |
tree | dcd162f56a5dbeac6ee669fc85d582813fd48eea /doc/source/documentation/excellon.rst | |
parent | c3ca4f95bd59f69d45e582a4149327f57a360760 (diff) | |
download | gerbonara-7473e471dc69d09a35bb0762549cc4f3ab8b04b3.tar.gz gerbonara-7473e471dc69d09a35bb0762549cc4f3ab8b04b3.tar.bz2 gerbonara-7473e471dc69d09a35bb0762549cc4f3ab8b04b3.zip |
Add some documentation
Diffstat (limited to 'doc/source/documentation/excellon.rst')
-rw-r--r-- | doc/source/documentation/excellon.rst | 42 |
1 files changed, 0 insertions, 42 deletions
diff --git a/doc/source/documentation/excellon.rst b/doc/source/documentation/excellon.rst deleted file mode 100644 index 9cd7ee1..0000000 --- a/doc/source/documentation/excellon.rst +++ /dev/null @@ -1,42 +0,0 @@ -: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 classes 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: - |