diff options
Diffstat (limited to 'doc/source')
-rw-r--r-- | doc/source/about.rst | 40 | ||||
-rw-r--r-- | doc/source/conf.py | 16 | ||||
-rw-r--r-- | doc/source/documentation/index.rst | 5 | ||||
-rw-r--r-- | doc/source/documentation/operations.rst | 24 | ||||
-rw-r--r-- | doc/source/documentation/rs274x.rst | 2 | ||||
-rw-r--r-- | doc/source/features.rst | 14 | ||||
-rw-r--r-- | doc/source/index.rst | 7 | ||||
-rw-r--r-- | doc/source/intro.rst | 19 |
8 files changed, 93 insertions, 34 deletions
diff --git a/doc/source/about.rst b/doc/source/about.rst new file mode 100644 index 0000000..85e7184 --- /dev/null +++ b/doc/source/about.rst @@ -0,0 +1,40 @@ +About PCB Tools +=============== + + +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) <http://en.wikipedia.org/wiki/Gerber_format>`_, +`ODB++ <http://en.wikipedia.org/wiki/ODB%2B%2B>`_ , +or `Excellon <http://en.wikipedia.org/wiki/Excellon_format>`_ files. These +file formats are used by the CNC equipment used to manufacutre PCBs. + +PCB Tools currently supports the following file formats: + +- Gerber (RS-274X) +- Excellon + +with planned support for IPC-2581, ODB++ and more. + +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. + + + + +Future Plans +~~~~~~~~~~~~ +We are working on adding the following features to PCB Tools: + +- Design Rules Checking +- Editing +- Panelization + + + diff --git a/doc/source/conf.py b/doc/source/conf.py index a118546..238a0b8 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 <ph.silva@gmail.com>, Hamilton Kibbe <ham@hamiltonkib.be>'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -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.
@@ -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..dec83f9 100644 --- a/doc/source/documentation/index.rst +++ b/doc/source/documentation/index.rst @@ -1,4 +1,4 @@ -Gerber Tools Reference +PCB Tools Reference ====================== .. toctree:: @@ -6,6 +6,5 @@ Gerber Tools Reference Gerber (RS-274X) Files <rs274x> Excellon Files <excellon> + Operations <operations> Rendering <render> - - 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 <ham@hamiltonkib.be> + + +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/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/features.rst b/doc/source/features.rst new file mode 100644 index 0000000..67d9e2a --- /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 Yes No +Excellon Yes Yes Yes No Yes No +ODB++ No No No No No No +============ ======== =========== ================ ====== ======= ======= + + diff --git a/doc/source/index.rst b/doc/source/index.rst index aec8b48..c96ff8a 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:
@@ -11,7 +11,8 @@ Contents: .. toctree::
:maxdepth: 1
- intro
+ about
+ features
documentation/index
Indices and tables
diff --git a/doc/source/intro.rst b/doc/source/intro.rst deleted file mode 100644 index 1982fc8..0000000 --- a/doc/source/intro.rst +++ /dev/null @@ -1,19 +0,0 @@ -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) <http://en.wikipedia.org/wiki/Gerber_format>`_, -`ODB++ <http://en.wikipedia.org/wiki/ODB%2B%2B>`_, or `Excellon <http://en.wikipedia.org/wiki/Excellon_format>`_ -files. - - -Gerber-Tools ------------- - -The gerber-tools module provides tools for working with and rendering Gerber -and Excellon files. - - |