From c60a858c9c28b99bea270bc63bd6126fcb3ee20b Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Sun, 28 Sep 2014 21:18:25 -0400 Subject: added doc folder --- doc/source/conf.py | 260 +++++++++++++++++++++++++++++++++++++++++++++++++++ doc/source/index.rst | 29 ++++++ 2 files changed, 289 insertions(+) create mode 100644 doc/source/conf.py create mode 100644 doc/source/index.rst (limited to 'doc/source') diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000..bf45678 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,260 @@ +# -*- coding: utf-8 -*- +# +# Gerber Tools documentation build configuration file, created by +# sphinx-quickstart on Sun Sep 28 18:16:46 2014. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath('../../')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Gerber Tools' +copyright = u'2014, 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 +# built documents. +# +# The short X.Y version. +version = '0.1' +# The full version, including alpha/beta/rc tags. +release = '0.1' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'GerberToolsdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ('index', 'GerberTools.tex', u'Gerber Tools Documentation', + u'Hamilton Kibbe', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'gerbertools', u'Gerber Tools Documentation', + [u'Hamilton Kibbe'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (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.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..ac28b5b --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,29 @@ +.. Gerber 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. + +Welcome to Gerber Tools's documentation! +======================================== + +Contents: + +.. toctree:: + :maxdepth: 2 + +.. automodule:: gerber.gerber + :members: + +.. automodule:: gerber.statements + :members: + +.. automodule:: gerber.utils + :members: + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + -- cgit From 0b8e2e4b8b552e90d55eabe39aefba0b5b3daef5 Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Wed, 1 Oct 2014 14:39:32 -0400 Subject: added numpydoc --- doc/source/conf.py | 521 ++++++++++++++++++++++++++------------------------- doc/source/index.rst | 67 ++++--- 2 files changed, 299 insertions(+), 289 deletions(-) (limited to 'doc/source') diff --git a/doc/source/conf.py b/doc/source/conf.py index bf45678..0a3cfc1 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -1,260 +1,261 @@ -# -*- coding: utf-8 -*- -# -# Gerber Tools documentation build configuration file, created by -# sphinx-quickstart on Sun Sep 28 18:16:46 2014. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys -import os - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.abspath('../../')) - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - 'sphinx.ext.autodoc', -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'Gerber Tools' -copyright = u'2014, 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 -# built documents. -# -# The short X.Y version. -version = '0.1' -# The full version, including alpha/beta/rc tags. -release = '0.1' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = [] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'default' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -#html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = 'GerberToolsdoc' - - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -#'preamble': '', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ('index', 'GerberTools.tex', u'Gerber Tools Documentation', - u'Hamilton Kibbe', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'gerbertools', u'Gerber Tools Documentation', - [u'Hamilton Kibbe'], 1) -] - -# If true, show URL addresses after external links. -#man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (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.', - 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False +# -*- coding: utf-8 -*- +# +# Gerber Tools documentation build configuration file, created by +# sphinx-quickstart on Sun Sep 28 18:16:46 2014. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath('../../')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'numpydoc', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Gerber Tools' +copyright = u'2014, 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 +# built documents. +# +# The short X.Y version. +version = '0.1' +# The full version, including alpha/beta/rc tags. +release = '0.1' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'GerberToolsdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ('index', 'GerberTools.tex', u'Gerber Tools Documentation', + u'Hamilton Kibbe', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'gerbertools', u'Gerber Tools Documentation', + [u'Hamilton Kibbe'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (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.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False diff --git a/doc/source/index.rst b/doc/source/index.rst index ac28b5b..a5916f7 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,29 +1,38 @@ -.. Gerber 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. - -Welcome to Gerber Tools's documentation! -======================================== - -Contents: - -.. toctree:: - :maxdepth: 2 - -.. automodule:: gerber.gerber - :members: - -.. automodule:: gerber.statements - :members: - -.. automodule:: gerber.utils - :members: - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - +.. Gerber 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. + +Welcome to Gerber Tools's documentation! +======================================== + +Contents: + +.. toctree:: + :maxdepth: 2 + +.. automodule:: gerber + :members: + +.. automodule:: gerber.gerber + :members: + +.. automodule:: gerber.excellon + :members: + +.. automodule:: gerber.cnc + :members: + +.. automodule:: gerber.statements + :members: + +.. automodule:: gerber.utils + :members: + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + -- cgit From f2f411493ea303075d5dbdd7656c572dda61cf67 Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Thu, 9 Oct 2014 22:10:28 -0400 Subject: doc update --- doc/source/index.rst | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) (limited to 'doc/source') diff --git a/doc/source/index.rst b/doc/source/index.rst index a5916f7..763d04a 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -20,12 +20,18 @@ Contents: .. automodule:: gerber.excellon :members: -.. automodule:: gerber.cnc +.. automodule:: gerber.render.render :members: -.. automodule:: gerber.statements +.. automodule:: gerber.gerber_statements :members: - + +.. automodule:: gerber.excellon_statements + :members: + +.. automodule:: gerber.cnc + :members: + .. automodule:: gerber.utils :members: -- cgit 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/source') 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/source') 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 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