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/conf.py | 1 + doc/source/documentation/excellon.rst | 42 +++++++++++++++++++++++++++++++++++ doc/source/documentation/gerber.rst | 36 ++++++++++++++++++++++++++++++ doc/source/documentation/index.rst | 11 +++++++++ doc/source/documentation/render.rst | 11 +++++++++ doc/source/index.rst | 29 ++++-------------------- doc/source/intro.rst | 19 ++++++++++++++++ 7 files changed, 124 insertions(+), 25 deletions(-) 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 create mode 100644 doc/source/intro.rst (limited to 'doc') diff --git a/doc/source/conf.py b/doc/source/conf.py index 0a3cfc1..ac0fdf7 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -30,6 +30,7 @@ sys.path.insert(0, os.path.abspath('../../')) # ones. extensions = [ 'sphinx.ext.autodoc', + 'sphinx.ext.autosummary', 'numpydoc', ] 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: diff --git a/doc/source/index.rst b/doc/source/index.rst index 763d04a..aec8b48 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -3,37 +3,16 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Gerber Tools's documentation! +Gerber-Tools! ======================================== Contents: .. toctree:: - :maxdepth: 2 - -.. automodule:: gerber - :members: - -.. automodule:: gerber.gerber - :members: - -.. automodule:: gerber.excellon - :members: - -.. automodule:: gerber.render.render - :members: - -.. automodule:: gerber.gerber_statements - :members: - -.. automodule:: gerber.excellon_statements - :members: - -.. automodule:: gerber.cnc - :members: + :maxdepth: 1 -.. automodule:: gerber.utils - :members: + intro + documentation/index Indices and tables ================== diff --git a/doc/source/intro.rst b/doc/source/intro.rst new file mode 100644 index 0000000..1982fc8 --- /dev/null +++ b/doc/source/intro.rst @@ -0,0 +1,19 @@ +Gerber Tools Intro +================== + +PCB CAM (Gerber) Files +------------ + +PCB design files (artwork) are most often stored in `Gerber` files. This is +a generic term that may refer to `RS-274X (Gerber) `_, +`ODB++ `_, or `Excellon `_ +files. + + +Gerber-Tools +------------ + +The gerber-tools module provides tools for working with and rendering Gerber +and Excellon files. + + -- 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/conf.py | 2 +- doc/source/documentation/gerber.rst | 36 ------------------------------------ doc/source/documentation/index.rst | 2 +- doc/source/documentation/rs274x.rst | 37 +++++++++++++++++++++++++++++++++++++ 4 files changed, 39 insertions(+), 38 deletions(-) delete mode 100644 doc/source/documentation/gerber.rst create mode 100644 doc/source/documentation/rs274x.rst (limited to 'doc') diff --git a/doc/source/conf.py b/doc/source/conf.py index ac0fdf7..a118546 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -86,7 +86,7 @@ exclude_patterns = [] # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' 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