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/conf.py | 14 +++++++------- doc/source/documentation/index.rst | 2 +- doc/source/documentation/rs274x.rst | 2 +- doc/source/index.rst | 4 ++-- doc/source/intro.rst | 4 ++-- 5 files changed, 13 insertions(+), 13 deletions(-) (limited to 'doc/source') diff --git a/doc/source/conf.py b/doc/source/conf.py index a118546..7a8134e 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -47,8 +47,8 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Gerber Tools' -copyright = u'2014, Hamilton Kibbe' +project = u'PCB Tools' +copyright = u'2014 Paulo Henrique Silva , Hamilton Kibbe ' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -180,7 +180,7 @@ html_static_path = ['_static'] #html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'GerberToolsdoc' +htmlhelp_basename = 'PCBToolsdoc' # -- Options for LaTeX output --------------------------------------------- @@ -200,7 +200,7 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - ('index', 'GerberTools.tex', u'Gerber Tools Documentation', + ('index', 'PCBTools.tex', u'PCB Tools Documentation', u'Hamilton Kibbe', 'manual'), ] @@ -230,7 +230,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'gerbertools', u'Gerber Tools Documentation', + ('index', 'pcbtools', u'PCB Tools Documentation', [u'Hamilton Kibbe'], 1) ] @@ -244,8 +244,8 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'GerberTools', u'Gerber Tools Documentation', - u'Hamilton Kibbe', 'GerberTools', 'One line description of project.', + ('index', 'PCBTools', u'PCB Tools Documentation', + u'Hamilton Kibbe', 'PCBTools', 'Tools for working with PCB CAM files.', 'Miscellaneous'), ] 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 diff --git a/doc/source/index.rst b/doc/source/index.rst index aec8b48..309cf88 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,9 +1,9 @@ -.. Gerber Tools documentation master file, created by +.. PCB-tools documentation master file, created by sphinx-quickstart on Sun Sep 28 18:16:46 2014. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Gerber-Tools! +PCB-Tools ======================================== Contents: diff --git a/doc/source/intro.rst b/doc/source/intro.rst index 1982fc8..4db80ad 100644 --- a/doc/source/intro.rst +++ b/doc/source/intro.rst @@ -1,4 +1,4 @@ -Gerber Tools Intro +PCB Tools Intro ================== PCB CAM (Gerber) Files @@ -10,7 +10,7 @@ a generic term that may refer to `RS-274X (Gerber) Date: Fri, 5 Dec 2014 23:59:28 -0500 Subject: add ipc2581 primitives --- doc/source/about.rst | 38 ++++++++++++++++++++++++++++++++++++++ doc/source/index.rst | 2 +- doc/source/intro.rst | 19 ------------------- 3 files changed, 39 insertions(+), 20 deletions(-) create mode 100644 doc/source/about.rst delete mode 100644 doc/source/intro.rst (limited to 'doc/source') diff --git a/doc/source/about.rst b/doc/source/about.rst new file mode 100644 index 0000000..1bb354c --- /dev/null +++ b/doc/source/about.rst @@ -0,0 +1,38 @@ +About PCB Tools +=============== + +PCB CAM Files +~~~~~~~~~~~~~ + +PCB design (artwork) files are most often stored in `Gerber` files. This is +a generic term that may refer to `RS-274X (Gerber) `_, +`ODB++ `_ , or `Excellon `_ +files. These file formats are used by the CNC equipment used to manufacutre PCBs. + +PCB Tools provides a set of utilities for visualizing and working with PCB design files +in a variety of formats. PCB Tools currently supports the following file formats: + +- Gerber (RS-274X) +- Excellon + +with planned support for IPC-2581, IPC-D-356 Netlists, ODB++ and more. + +Visualization +~~~~~~~~~~~~~~ +.. image:: ../../examples/composite_top.png + :alt: Rendering Example + +The PCB Tools module provides tools to visualize PCBs and export images in a variety of formats, +including SVG and PNG. + + +Future Plans +~~~~~~~~~~~~ +We are working on adding the following features to PCB Tools: + +- Design Rules Checking +- Editing +- Panelization + + + diff --git a/doc/source/index.rst b/doc/source/index.rst index 309cf88..ab29738 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -11,7 +11,7 @@ Contents: .. toctree:: :maxdepth: 1 - intro + about documentation/index Indices and tables diff --git a/doc/source/intro.rst b/doc/source/intro.rst deleted file mode 100644 index 4db80ad..0000000 --- a/doc/source/intro.rst +++ /dev/null @@ -1,19 +0,0 @@ -PCB 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. - - -PCB-Tools ------------- - -The gerber-tools module provides tools for working with and rendering Gerber -and Excellon files. - - -- 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') 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 bc532997aecc60f5a939f9ca6ba55dd3eae27a42 Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Sun, 15 Feb 2015 22:00:03 -0500 Subject: Add feature support table per #9 --- doc/source/about.rst | 30 ++++++++++++++++-------------- doc/source/features.rst | 14 ++++++++++++++ doc/source/index.rst | 1 + 3 files changed, 31 insertions(+), 14 deletions(-) create mode 100644 doc/source/features.rst (limited to 'doc/source') diff --git a/doc/source/about.rst b/doc/source/about.rst index 1bb354c..85e7184 100644 --- a/doc/source/about.rst +++ b/doc/source/about.rst @@ -1,29 +1,31 @@ About PCB Tools =============== -PCB CAM Files -~~~~~~~~~~~~~ -PCB design (artwork) files are most often stored in `Gerber` files. This is -a generic term that may refer to `RS-274X (Gerber) `_, -`ODB++ `_ , or `Excellon `_ -files. These file formats are used by the CNC equipment used to manufacutre PCBs. +PCB Tools provides a set of utilities for visualizing and working with PCB +design files in a variety of formats. The design files are generally referred +to as Gerber files. This is a generic term that may refer to +`RS-274X (Gerber) `_, +`ODB++ `_ , +or `Excellon `_ files. These +file formats are used by the CNC equipment used to manufacutre PCBs. -PCB Tools provides a set of utilities for visualizing and working with PCB design files -in a variety of formats. PCB Tools currently supports the following file formats: +PCB Tools currently supports the following file formats: - Gerber (RS-274X) - Excellon -with planned support for IPC-2581, IPC-D-356 Netlists, ODB++ and more. +with planned support for IPC-2581, ODB++ and more. -Visualization -~~~~~~~~~~~~~~ -.. image:: ../../examples/composite_top.png +Image Rendering +~~~~~~~~~~~~~~~ +.. image:: ../../examples/cairo_example.png :alt: Rendering Example -The PCB Tools module provides tools to visualize PCBs and export images in a variety of formats, -including SVG and PNG. +The PCB Tools module provides tools to visualize PCBs and export images in a +variety of formats, including SVG and PNG. + + Future Plans diff --git a/doc/source/features.rst b/doc/source/features.rst new file mode 100644 index 0000000..120fdcd --- /dev/null +++ b/doc/source/features.rst @@ -0,0 +1,14 @@ +Feature Suppport +================ + +Currently supported features are as follows: + +============ ======== =========== ================ ====== ======= ======= +File Format Parsing Rendering Unit Conversion Scale Offset Rotate +============ ======== =========== ================ ====== ======= ======= +RS274-X Yes Yes Yes No No No +Excellon Yes Yes Yes No No No +ODB++ No No No No No No +============ ======== =========== ================ ====== ======= ======= + + diff --git a/doc/source/index.rst b/doc/source/index.rst index ab29738..c96ff8a 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -12,6 +12,7 @@ Contents: :maxdepth: 1 about + features documentation/index Indices and tables -- 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 ++++++++++++++++++++++++ doc/source/features.rst | 6 +++--- 3 files changed, 28 insertions(+), 4 deletions(-) create mode 100644 doc/source/documentation/operations.rst (limited to 'doc/source') 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 + + + diff --git a/doc/source/features.rst b/doc/source/features.rst index 120fdcd..67d9e2a 100644 --- a/doc/source/features.rst +++ b/doc/source/features.rst @@ -3,11 +3,11 @@ Feature Suppport Currently supported features are as follows: -============ ======== =========== ================ ====== ======= ======= +============ ======== =========== ================ ====== ======= ======= File Format Parsing Rendering Unit Conversion Scale Offset Rotate ============ ======== =========== ================ ====== ======= ======= -RS274-X Yes Yes Yes No No No -Excellon Yes Yes Yes No No No +RS274-X Yes Yes Yes No Yes No +Excellon Yes Yes Yes No Yes No ODB++ No No No No No No ============ ======== =========== ================ ====== ======= ======= -- cgit From b3e816466c9cd514854efd42803cb4258e4956b2 Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Wed, 18 Feb 2015 23:28:19 -0500 Subject: doc options --- doc/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/source') diff --git a/doc/source/conf.py b/doc/source/conf.py index 7a8134e..238a0b8 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -82,7 +82,7 @@ exclude_patterns = [] # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -#add_module_names = True +add_module_names = False # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -- cgit