conf.py
Go to the documentation of this file.
00001 # -*- coding: utf-8 -*-
00002 #
00003 # alrosbridge documentation build configuration file, created by
00004 # sphinx-quickstart on Mon May 11 08:53:19 2009.
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, subprocess
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 #
00020 # TDS:  the only way to get parameters in to this script is via env variables,
00021 # see the generated Makefile.in that knows where things are
00022 #
00023 sys.path += [os.path.abspath('.')]
00024 print "SYS.PATH===", sys.path
00025 
00026 # -- General configuration -----------------------------------------------------
00027 
00028 # Add any Sphinx extension module names here, as strings. They can be extensions
00029 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
00030 extensions = ['sphinx.ext.autodoc',
00031               'sphinx.ext.doctest',
00032               'sphinx.ext.todo',
00033               'sphinx.ext.coverage',
00034               'sphinx.ext.pngmath',
00035               'sphinx.ext.viewcode',
00036               'sphinx.ext.graphviz',
00037               'ToggleDirective']
00038 
00039 # extensions = ['sphinx.ext.ifconfig', 'sphinx.ext.todo'] #, 'cmake']
00040 todo_include_todos = True
00041 
00042 # Add any paths that contain templates here, relative to this directory.
00043 templates_path = ['_templates']
00044 
00045 # The suffix of source filenames.
00046 source_suffix = '.rst'
00047 
00048 # The encoding of source files.
00049 #source_encoding = 'utf-8'
00050 
00051 show_sphinx = False
00052 
00053 # The master toctree document.
00054 master_doc = 'index'
00055 
00056 # General information about the project.
00057 project = u'alrosbridge'
00058 
00059 # The version info for the project you're documenting, acts as replacement for
00060 # |version| and |release|, also used in various other places throughout the
00061 # built documents.
00062 #
00063 
00064 copyright = u'2015, Aldebaran, Inc'
00065 
00066 # The language for content autogenerated by Sphinx. Refer to documentation
00067 # for a list of supported languages.
00068 #language = None
00069 
00070 # There are two options for replacing |today|: either, you set today to some
00071 # non-false value, then it is used:
00072 #today = ''
00073 # Else, today_fmt is used as the format for a strftime call.
00074 #today_fmt = '%B %d, %Y'
00075 
00076 # List of documents that shouldn't be included in the build.
00077 #unused_docs = []
00078 
00079 # List of directories, relative to source directory, that shouldn't be searched
00080 # for source files.
00081 exclude_trees = []
00082 
00083 # The reST default role (used for this markup: `text`) to use for all documents.
00084 #default_role = None
00085 
00086 # If true, '()' will be appended to :func: etc. cross-reference text.
00087 #add_function_parentheses = True
00088 
00089 # If true, the current module name will be prepended to all description
00090 # unit titles (such as .. function::).
00091 #add_module_names = True
00092 
00093 # If true, sectionauthor and moduleauthor directives will be shown in the
00094 # output. They are ignored by default.
00095 show_authors = True
00096 
00097 # The name of the Pygments (syntax highlighting) style to use.
00098 pygments_style = 'sphinx'
00099 
00100 # A list of ignored prefixes for module index sorting.
00101 #modindex_common_prefix = []
00102 
00103 
00104 # -- Options for HTML output ---------------------------------------------------
00105 
00106 # The theme to use for HTML and HTML Help pages.  Major themes that come with
00107 # Sphinx are currently 'default' and 'sphinxdoc'.
00108 html_theme = 'default'
00109 
00110 # Theme options are theme-specific and customize the look and feel of a theme
00111 # further.  For a list of options available for each theme, see the
00112 # documentation.
00113 html_theme_options = { }
00114 
00115 # Add any paths that contain custom themes here, relative to this directory.
00116 html_theme_path = ['.']
00117 
00118 # The name for this set of Sphinx documents.  If None, it defaults to
00119 # "<project> v<release> documentation".
00120 #html_title = 'alrosbridge ' + gittag_short
00121 
00122 # A shorter title for the navigation bar.  Default is the same as html_title.
00123 #html_short_title = None
00124 
00125 # The name of an image file (relative to this directory) to place at the top
00126 # of the sidebar.
00127 #html_logo = ''
00128 
00129 # The name of an image file (within the static path) to use as favicon of the
00130 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
00131 # pixels large.
00132 #html_favicon = None
00133 
00134 # Add any paths that contain custom static files (such as style sheets) here,
00135 # relative to this directory. They are copied after the builtin static files,
00136 # so a file named "default.css" will overwrite the builtin "default.css".
00137 #html_static_path = ['_static']
00138 
00139 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
00140 # using the given strftime format.
00141 #
00142 # tds: We don't use this, we use the git timestamp
00143 #
00144 # html_last_updated_fmt = '%b %d, %Y'
00145 
00146 # If true, SmartyPants will be used to convert quotes and dashes to
00147 # typographically correct entities.
00148 #html_use_smartypants = True
00149 
00150 # Custom sidebar templates, maps document names to template names.
00151 #html_sidebars = {}
00152 
00153 # Additional templates that should be rendered to pages, maps page names to
00154 # template names.
00155 #html_additional_pages = {}
00156 
00157 # If false, no module index is generated.
00158 #html_use_modindex = True
00159 
00160 # If false, no index is generated.
00161 #html_use_index = True
00162 
00163 # If true, the index is split into individual pages for each letter.
00164 #html_split_index = False
00165 
00166 # If true, links to the reST sources are added to the pages.
00167 #html_show_sourcelink = True
00168 
00169 # If true, an OpenSearch description file will be output, and all pages will
00170 # contain a <link> tag referring to it.  The value of this option must be the
00171 # base URL from which the finished HTML is served.
00172 #html_use_opensearch = ''
00173 
00174 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
00175 #html_file_suffix = ''
00176 
00177 # Output file base name for HTML help builder.
00178 #htmlhelp_basename = 'alrosbridge-cmakedoc'
00179 
00180 
00181 # -- Options for LaTeX output --------------------------------------------------
00182 
00183 # The paper size ('letter' or 'a4').
00184 #latex_paper_size = 'letter'
00185 
00186 # The font size ('10pt', '11pt' or '12pt').
00187 #latex_font_size = '10pt'
00188 
00189 # Grouping the document tree into LaTeX files. List of tuples
00190 # (source start file, target name, title, author, documentclass [howto/manual]).
00191 #latex_documents = []
00192 
00193 # The name of an image file (relative to this directory) to place at the top of
00194 # the title page.
00195 #latex_logo = None
00196 
00197 # For "manual" documents, if this is true, then toplevel headings are parts,
00198 # not chapters.
00199 #latex_use_parts = False
00200 
00201 # Additional stuff for the LaTeX preamble.
00202 #latex_preamble = ''
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_use_modindex = True
00209 
00210 graphviz_output_format = 'png' #'svg' truncates all other doc output after the ectoplot directive.
00211 
00212 rst_epilog = """
00213 
00214 
00215 """
00216 


naoqi_driver
Author(s): Karsten Knese
autogenerated on Sun Sep 17 2017 02:57:14