00001 # -*- coding: utf-8 -*- 00002 # 00003 # robot_dashboard documentation build configuration file, created by 00004 # sphinx-quickstart on Wed Aug 1 14:10:04 2012. 00005 # 00006 # This file is execfile()d with the current directory set to its containing dir. 00007 # 00008 # Note that not all possible configuration values are present in this 00009 # autogenerated file. 00010 # 00011 # All configuration values have a default; values that are commented out 00012 # serve to show the default. 00013 00014 import sys, os 00015 00016 # If extensions (or modules to document with autodoc) are in another directory, 00017 # add these directories to sys.path here. If the directory is relative to the 00018 # documentation root, use os.path.abspath to make it absolute, like shown here. 00019 sys.path.insert(0, os.path.abspath('../../src')) 00020 00021 # -- General configuration ----------------------------------------------------- 00022 00023 # If your documentation needs a minimal Sphinx version, state it here. 00024 #needs_sphinx = '1.0' 00025 00026 # Add any Sphinx extension module names here, as strings. They can be extensions 00027 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 00028 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode'] 00029 00030 # Add any paths that contain templates here, relative to this directory. 00031 templates_path = ['_templates'] 00032 00033 # The suffix of source filenames. 00034 source_suffix = '.rst' 00035 00036 # The encoding of source files. 00037 #source_encoding = 'utf-8-sig' 00038 00039 # The master toctree document. 00040 master_doc = 'index' 00041 00042 # General information about the project. 00043 project = u'robot_dashboard' 00044 copyright = u'2012, Ze\'ev Klapow' 00045 00046 # The version info for the project you're documenting, acts as replacement for 00047 # |version| and |release|, also used in various other places throughout the 00048 # built documents. 00049 # 00050 # The short X.Y version. 00051 version = '0' 00052 # The full version, including alpha/beta/rc tags. 00053 release = '0.1.0' 00054 00055 # The language for content autogenerated by Sphinx. Refer to documentation 00056 # for a list of supported languages. 00057 #language = None 00058 00059 # There are two options for replacing |today|: either, you set today to some 00060 # non-false value, then it is used: 00061 #today = '' 00062 # Else, today_fmt is used as the format for a strftime call. 00063 #today_fmt = '%B %d, %Y' 00064 00065 # List of patterns, relative to source directory, that match files and 00066 # directories to ignore when looking for source files. 00067 exclude_patterns = [] 00068 00069 # The reST default role (used for this markup: `text`) to use for all documents. 00070 #default_role = None 00071 00072 # If true, '()' will be appended to :func: etc. cross-reference text. 00073 #add_function_parentheses = True 00074 00075 # If true, the current module name will be prepended to all description 00076 # unit titles (such as .. function::). 00077 #add_module_names = True 00078 00079 # If true, sectionauthor and moduleauthor directives will be shown in the 00080 # output. They are ignored by default. 00081 #show_authors = False 00082 00083 # The name of the Pygments (syntax highlighting) style to use. 00084 pygments_style = 'sphinx' 00085 00086 # A list of ignored prefixes for module index sorting. 00087 #modindex_common_prefix = [] 00088 00089 00090 # -- Options for HTML output --------------------------------------------------- 00091 00092 # The theme to use for HTML and HTML Help pages. See the documentation for 00093 # a list of builtin themes. 00094 html_theme = 'default' 00095 00096 # Theme options are theme-specific and customize the look and feel of a theme 00097 # further. For a list of options available for each theme, see the 00098 # documentation. 00099 #html_theme_options = {} 00100 00101 # Add any paths that contain custom themes here, relative to this directory. 00102 #html_theme_path = [] 00103 00104 # The name for this set of Sphinx documents. If None, it defaults to 00105 # "<project> v<release> documentation". 00106 #html_title = None 00107 00108 # A shorter title for the navigation bar. Default is the same as html_title. 00109 #html_short_title = None 00110 00111 # The name of an image file (relative to this directory) to place at the top 00112 # of the sidebar. 00113 #html_logo = None 00114 00115 # The name of an image file (within the static path) to use as favicon of the 00116 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 00117 # pixels large. 00118 #html_favicon = None 00119 00120 # Add any paths that contain custom static files (such as style sheets) here, 00121 # relative to this directory. They are copied after the builtin static files, 00122 # so a file named "default.css" will overwrite the builtin "default.css". 00123 html_static_path = ['_static'] 00124 00125 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 00126 # using the given strftime format. 00127 #html_last_updated_fmt = '%b %d, %Y' 00128 00129 # If true, SmartyPants will be used to convert quotes and dashes to 00130 # typographically correct entities. 00131 #html_use_smartypants = True 00132 00133 # Custom sidebar templates, maps document names to template names. 00134 #html_sidebars = {} 00135 00136 # Additional templates that should be rendered to pages, maps page names to 00137 # template names. 00138 #html_additional_pages = {} 00139 00140 # If false, no module index is generated. 00141 #html_domain_indices = True 00142 00143 # If false, no index is generated. 00144 #html_use_index = True 00145 00146 # If true, the index is split into individual pages for each letter. 00147 #html_split_index = False 00148 00149 # If true, links to the reST sources are added to the pages. 00150 #html_show_sourcelink = True 00151 00152 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 00153 #html_show_sphinx = True 00154 00155 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 00156 #html_show_copyright = True 00157 00158 # If true, an OpenSearch description file will be output, and all pages will 00159 # contain a <link> tag referring to it. The value of this option must be the 00160 # base URL from which the finished HTML is served. 00161 #html_use_opensearch = '' 00162 00163 # This is the file name suffix for HTML files (e.g. ".xhtml"). 00164 #html_file_suffix = None 00165 00166 # Output file base name for HTML help builder. 00167 htmlhelp_basename = 'robot_dashboarddoc' 00168 00169 00170 # -- Options for LaTeX output -------------------------------------------------- 00171 00172 latex_elements = { 00173 # The paper size ('letterpaper' or 'a4paper'). 00174 #'papersize': 'letterpaper', 00175 00176 # The font size ('10pt', '11pt' or '12pt'). 00177 #'pointsize': '10pt', 00178 00179 # Additional stuff for the LaTeX preamble. 00180 #'preamble': '', 00181 } 00182 00183 # Grouping the document tree into LaTeX files. List of tuples 00184 # (source start file, target name, title, author, documentclass [howto/manual]). 00185 latex_documents = [ 00186 ('index', 'robot_dashboard.tex', u'robot\\_dashboard Documentation', 00187 u'Ze\'ev Klapow', 'manual'), 00188 ] 00189 00190 # The name of an image file (relative to this directory) to place at the top of 00191 # the title page. 00192 #latex_logo = None 00193 00194 # For "manual" documents, if this is true, then toplevel headings are parts, 00195 # not chapters. 00196 #latex_use_parts = False 00197 00198 # If true, show page references after internal links. 00199 #latex_show_pagerefs = False 00200 00201 # If true, show URL addresses after external links. 00202 #latex_show_urls = False 00203 00204 # Documents to append as an appendix to all manuals. 00205 #latex_appendices = [] 00206 00207 # If false, no module index is generated. 00208 #latex_domain_indices = True 00209 00210 00211 # -- Options for manual page output -------------------------------------------- 00212 00213 # One entry per manual page. List of tuples 00214 # (source start file, name, description, authors, manual section). 00215 man_pages = [ 00216 ('index', 'robot_dashboard', u'robot_dashboard Documentation', 00217 [u'Ze\'ev Klapow'], 1) 00218 ] 00219 00220 # If true, show URL addresses after external links. 00221 #man_show_urls = False 00222 00223 00224 # -- Options for Texinfo output ------------------------------------------------ 00225 00226 # Grouping the document tree into Texinfo files. List of tuples 00227 # (source start file, target name, title, author, 00228 # dir menu entry, description, category) 00229 texinfo_documents = [ 00230 ('index', 'robot_dashboard', u'robot_dashboard Documentation', 00231 u'Ze\'ev Klapow', 'robot_dashboard', 'One line description of project.', 00232 'Miscellaneous'), 00233 ] 00234 00235 # Documents to append as an appendix to all manuals. 00236 #texinfo_appendices = [] 00237 00238 # If false, no module index is generated. 00239 #texinfo_domain_indices = True 00240 00241 # How to display URL addresses: 'footnote', 'no', or 'inline'. 00242 #texinfo_show_urls = 'footnote'