diff options
| author | Hamilton Kibbe <hamilton.kibbe@gmail.com> | 2014-10-12 12:38:40 -0400 |
|---|---|---|
| committer | Hamilton Kibbe <hamilton.kibbe@gmail.com> | 2014-10-12 12:38:40 -0400 |
| commit | 8c5c7ec8bbc8a074884ef04b566f9c0ecd6e78bb (patch) | |
| tree | a9032538e4a96f11a9ec16d1c761f4d8862529a8 /doc | |
| parent | d9018da412470053a063b7b28b5e32529fc573f6 (diff) | |
| download | gerbonara-8c5c7ec8bbc8a074884ef04b566f9c0ecd6e78bb.tar.gz gerbonara-8c5c7ec8bbc8a074884ef04b566f9c0ecd6e78bb.tar.bz2 gerbonara-8c5c7ec8bbc8a074884ef04b566f9c0ecd6e78bb.zip | |
update docs and example images
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/conf.py | 2 | ||||
| -rw-r--r-- | doc/source/documentation/index.rst | 2 | ||||
| -rw-r--r-- | doc/source/documentation/rs274x.rst (renamed from doc/source/documentation/gerber.rst) | 19 |
3 files changed, 12 insertions, 11 deletions
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/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> + Gerber (RS-274X) Files <rs274x> Excellon Files <excellon> Rendering <render> diff --git a/doc/source/documentation/gerber.rst b/doc/source/documentation/rs274x.rst index 78870a9..bc99519 100644 --- a/doc/source/documentation/gerber.rst +++ b/doc/source/documentation/rs274x.rst @@ -1,7 +1,7 @@ -:mod:`gerber` --- RS-274X file handling +:mod:`rs274x` --- RS-274X file handling ============================================== -.. module:: gerber +.. module:: rs274x :synopsis: Functions and classes for handling RS-274X files .. sectionauthor:: Hamilton Kibbe <ham@hamiltonkib.be> @@ -9,28 +9,29 @@ The RS-274X (Gerber) format is the most common format for exporting PCB artwork. The Specification is published by Ucamco and is available `here <http://www.ucamco.com/files/downloads/file/81/the_gerber_file_format_specification.pdf>`_. -The :mod:`gerber` submodule implements calsses to read and write +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:`gerber` submodule's :func:`read` function serves as a +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:`gerber` module defines the following functions: +The :mod:`rs274x` module defines the following functions: -.. autofunction:: gerber.gerber.read +.. autofunction:: gerber.rs274x.read Classes ------- -The :mod:`gerber` module defines the following classes: +The :mod:`rs274x` module defines the following classes: -.. autoclass:: gerber.gerber.GerberFile +.. autoclass:: gerber.rs274x.GerberFile :members: -.. autoclass:: gerber.gerber.GerberParser +.. autoclass:: gerber.rs274x.GerberParser :members:
\ No newline at end of file |