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)