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/rs274x.rst | 37 ------------------------------------- 1 file changed, 37 deletions(-) delete mode 100644 doc/source/documentation/rs274x.rst (limited to 'doc/source/documentation/rs274x.rst') diff --git a/doc/source/documentation/rs274x.rst b/doc/source/documentation/rs274x.rst deleted file mode 100644 index 064c82f..0000000 --- a/doc/source/documentation/rs274x.rst +++ /dev/null @@ -1,37 +0,0 @@ -:mod:`rs274x` --- RS-274X file handling -============================================== - -.. module:: rs274x - :synopsis: Functions and classes for handling RS-274X files -.. sectionauthor:: Hamilton Kibbe - - -The RS-274X (Gerber) format is the most common format for exporting PCB -artwork. The Specification is published by Ucamco and is available -`here `_. -The :mod:`rs274x` submodule implements classes to read and write -RS-274X files without having to know the precise details of the format. - -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:`rs274x` module defines the following functions: - -.. autofunction:: gerber.rs274x.read - -Classes -------- -The :mod:`rs274x` module defines the following classes: - -.. autoclass:: gerber.rs274x.GerberFile - :members: - -.. autoclass:: gerber.rs274x.GerberParser - :members: -- cgit