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 --------------------------------- doc/source/documentation/index.rst | 10 -------- doc/source/documentation/operations.rst | 24 ------------------- doc/source/documentation/render.rst | 11 --------- doc/source/documentation/rs274x.rst | 37 ----------------------------- 5 files changed, 124 deletions(-) delete mode 100644 doc/source/documentation/excellon.rst delete mode 100644 doc/source/documentation/index.rst delete mode 100644 doc/source/documentation/operations.rst delete mode 100644 doc/source/documentation/render.rst delete mode 100644 doc/source/documentation/rs274x.rst (limited to 'doc/source/documentation') 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: - diff --git a/doc/source/documentation/index.rst b/doc/source/documentation/index.rst deleted file mode 100644 index dec83f9..0000000 --- a/doc/source/documentation/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -PCB Tools Reference -====================== - -.. toctree:: - :maxdepth: 2 - - Gerber (RS-274X) Files - Excellon Files - Operations - Rendering diff --git a/doc/source/documentation/operations.rst b/doc/source/documentation/operations.rst deleted file mode 100644 index 6551236..0000000 --- a/doc/source/documentation/operations.rst +++ /dev/null @@ -1,24 +0,0 @@ -:mod:`operations` --- Cam File operations -========================================= - -.. module:: operations - :synopsis: Functions for modifying CAM files -.. sectionauthor:: Hamilton Kibbe - - -The :mod:`operations` module provides functions which modify -:class:`gerber.cam.CamFile` objects. All of the functions in this module -return a modified copy of the supplied file. - -.. _operations-contents: - -Functions ---------- -The :mod:`operations` module defines the following functions: - -.. autofunction:: gerber.operations.to_inch -.. autofunction:: gerber.operations.to_metric -.. autofunction:: gerber.operations.offset - - - diff --git a/doc/source/documentation/render.rst b/doc/source/documentation/render.rst deleted file mode 100644 index 324ef71..0000000 --- a/doc/source/documentation/render.rst +++ /dev/null @@ -1,11 +0,0 @@ -:mod:`render` --- Gerber file Rendering -============================================== - -.. module:: render - :synopsis: Functions and classes for handling Excellon files -.. sectionauthor:: Hamilton Kibbe - -Render Module -------------- -.. automodule:: gerber.render.render - :members: 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