From 7473e471dc69d09a35bb0762549cc4f3ab8b04b3 Mon Sep 17 00:00:00 2001 From: jaseg Date: Tue, 1 Feb 2022 22:08:54 +0100 Subject: Add some documentation --- doc/source/documentation/excellon.rst | 42 ----------------------------------- 1 file changed, 42 deletions(-) delete mode 100644 doc/source/documentation/excellon.rst (limited to 'doc/source/documentation/excellon.rst') 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 - - -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 `_. 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: - -- cgit