From 62c689be172a7a06d76fd4b69c3443f3ec053765 Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Sat, 11 Oct 2014 13:12:21 -0400 Subject: Doc update --- doc/source/documentation/excellon.rst | 42 +++++++++++++++++++++++++++++++++++ doc/source/documentation/gerber.rst | 36 ++++++++++++++++++++++++++++++ doc/source/documentation/index.rst | 11 +++++++++ doc/source/documentation/render.rst | 11 +++++++++ 4 files changed, 100 insertions(+) create mode 100644 doc/source/documentation/excellon.rst create mode 100644 doc/source/documentation/gerber.rst create mode 100644 doc/source/documentation/index.rst create mode 100644 doc/source/documentation/render.rst (limited to 'doc/source/documentation') diff --git a/doc/source/documentation/excellon.rst b/doc/source/documentation/excellon.rst new file mode 100644 index 0000000..7ac3b39 --- /dev/null +++ b/doc/source/documentation/excellon.rst @@ -0,0 +1,42 @@ +: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 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: + \ No newline at end of file diff --git a/doc/source/documentation/gerber.rst b/doc/source/documentation/gerber.rst new file mode 100644 index 0000000..78870a9 --- /dev/null +++ b/doc/source/documentation/gerber.rst @@ -0,0 +1,36 @@ +:mod:`gerber` --- RS-274X file handling +============================================== + +.. module:: gerber + :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:`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: \ No newline at end of file diff --git a/doc/source/documentation/index.rst b/doc/source/documentation/index.rst new file mode 100644 index 0000000..110df87 --- /dev/null +++ b/doc/source/documentation/index.rst @@ -0,0 +1,11 @@ +Gerber Tools Reference +====================== + +.. toctree:: + :maxdepth: 2 + + Gerber (RS-274X) Files + Excellon Files + Rendering + + diff --git a/doc/source/documentation/render.rst b/doc/source/documentation/render.rst new file mode 100644 index 0000000..324ef71 --- /dev/null +++ b/doc/source/documentation/render.rst @@ -0,0 +1,11 @@ +: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: -- cgit From 8c5c7ec8bbc8a074884ef04b566f9c0ecd6e78bb Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Sun, 12 Oct 2014 12:38:40 -0400 Subject: update docs and example images --- doc/source/documentation/gerber.rst | 36 ------------------------------------ doc/source/documentation/index.rst | 2 +- doc/source/documentation/rs274x.rst | 37 +++++++++++++++++++++++++++++++++++++ 3 files changed, 38 insertions(+), 37 deletions(-) delete mode 100644 doc/source/documentation/gerber.rst create mode 100644 doc/source/documentation/rs274x.rst (limited to 'doc/source/documentation') diff --git a/doc/source/documentation/gerber.rst b/doc/source/documentation/gerber.rst deleted file mode 100644 index 78870a9..0000000 --- a/doc/source/documentation/gerber.rst +++ /dev/null @@ -1,36 +0,0 @@ -:mod:`gerber` --- RS-274X file handling -============================================== - -.. module:: gerber - :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:`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: \ No newline at end of file diff --git a/doc/source/documentation/index.rst b/doc/source/documentation/index.rst index 110df87..3d8241a 100644 --- a/doc/source/documentation/index.rst +++ b/doc/source/documentation/index.rst @@ -4,7 +4,7 @@ Gerber Tools Reference .. toctree:: :maxdepth: 2 - Gerber (RS-274X) Files + Gerber (RS-274X) Files Excellon Files Rendering diff --git a/doc/source/documentation/rs274x.rst b/doc/source/documentation/rs274x.rst new file mode 100644 index 0000000..bc99519 --- /dev/null +++ b/doc/source/documentation/rs274x.rst @@ -0,0 +1,37 @@ +: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 calsses 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: \ No newline at end of file -- cgit From b488ab6af9d7925263b2d0712abfd2ba55dc96d2 Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Tue, 28 Oct 2014 11:57:36 -0400 Subject: Doc update Update project name in docs --- doc/source/documentation/index.rst | 2 +- doc/source/documentation/rs274x.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'doc/source/documentation') diff --git a/doc/source/documentation/index.rst b/doc/source/documentation/index.rst index 3d8241a..6fbfa94 100644 --- a/doc/source/documentation/index.rst +++ b/doc/source/documentation/index.rst @@ -1,4 +1,4 @@ -Gerber Tools Reference +PCB Tools Reference ====================== .. toctree:: diff --git a/doc/source/documentation/rs274x.rst b/doc/source/documentation/rs274x.rst index bc99519..00094d4 100644 --- a/doc/source/documentation/rs274x.rst +++ b/doc/source/documentation/rs274x.rst @@ -33,5 +33,5 @@ The :mod:`rs274x` module defines the following classes: .. autoclass:: gerber.rs274x.GerberFile :members: -.. autoclass:: gerber.rs274x.GerberParser +.. autoclass:: gerber.rs274x.GerberParser :members: \ No newline at end of file -- cgit From 3435fecd3b29716f91531dc2998776ab82897f09 Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Sun, 8 Feb 2015 21:52:09 -0500 Subject: Add rest of Aperture Macro Primitives --- doc/source/documentation/index.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'doc/source/documentation') diff --git a/doc/source/documentation/index.rst b/doc/source/documentation/index.rst index 6fbfa94..28ecb99 100644 --- a/doc/source/documentation/index.rst +++ b/doc/source/documentation/index.rst @@ -7,5 +7,4 @@ PCB Tools Reference Gerber (RS-274X) Files Excellon Files Rendering - - + \ No newline at end of file -- cgit From 4db7302485e65937463c2efe3b3c2945549ca588 Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Wed, 18 Feb 2015 23:23:53 -0500 Subject: Doc update --- doc/source/documentation/index.rst | 2 +- doc/source/documentation/operations.rst | 24 ++++++++++++++++++++++++ 2 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 doc/source/documentation/operations.rst (limited to 'doc/source/documentation') diff --git a/doc/source/documentation/index.rst b/doc/source/documentation/index.rst index 28ecb99..dec83f9 100644 --- a/doc/source/documentation/index.rst +++ b/doc/source/documentation/index.rst @@ -6,5 +6,5 @@ PCB Tools Reference Gerber (RS-274X) Files Excellon Files + Operations Rendering - \ No newline at end of file diff --git a/doc/source/documentation/operations.rst b/doc/source/documentation/operations.rst new file mode 100644 index 0000000..6551236 --- /dev/null +++ b/doc/source/documentation/operations.rst @@ -0,0 +1,24 @@ +: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 + + + -- cgit