conf.py
Go to the documentation of this file.
00001 # All configuration values have a default; values that are commented out
00002 # serve to show the default.
00003 
00004 import sys, os
00005 
00006 # -- General configuration -----------------------------------------------------
00007 # Add any Sphinx extension module names here, as strings. They can be extensions
00008 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
00009 extensions = ['sphinx.ext.pngmath', 'sphinxcontrib.doxylink.doxylink']
00010 
00011 # Add any paths that contain templates here, relative to this directory.
00012 templates_path = ['_templates']
00013 
00014 # The suffix of source filenames.
00015 source_suffix = '.rst'
00016 
00017 # The master toctree document.
00018 master_doc = 'index'
00019 
00020 # General information about the project.
00021 project = u'PCL'
00022 copyright = ''
00023 
00024 # The version info for the project you're documenting, acts as replacement for
00025 # |version| and |release|, also used in various other places throughout the
00026 # built documents.
00027 #
00028 # The short X.Y version.
00029 version = '0.0'
00030 # The full version, including alpha/beta/rc tags.
00031 release = '0.0'
00032 
00033 # The language for content autogenerated by Sphinx. Refer to documentation
00034 # for a list of supported languages.
00035 #language = None
00036 
00037 # There are two options for replacing |today|: either, you set today to some
00038 # non-false value, then it is used:
00039 #today = ''
00040 # Else, today_fmt is used as the format for a strftime call.
00041 #today_fmt = '%B %d, %Y'
00042 
00043 # List of documents that shouldn't be included in the build.
00044 #unused_docs = []
00045 
00046 # List of directories, relative to source directory, that shouldn't be searched
00047 # for source files.
00048 exclude_trees = []
00049 
00050 # The reST default role (used for this markup: `text`) to use for all documents.
00051 default_role = None
00052 
00053 # If true, '()' will be appended to :func: etc. cross-reference text.
00054 #add_function_parentheses = True
00055 
00056 # If true, the current module name will be prepended to all description
00057 # unit titles (such as .. function::).
00058 add_module_names = False
00059 
00060 # If true, sectionauthor and moduleauthor directives will be shown in the
00061 # output. They are ignored by default.
00062 show_authors = False
00063 
00064 # The name of the Pygments (syntax highlighting) style to use.
00065 pygments_style = 'sphinx'
00066 
00067 # A list of ignored prefixes for module index sorting.
00068 #modindex_common_prefix = []
00069 
00070 # -- Options for HTML output ---------------------------------------------------
00071 
00072 # The theme to use for HTML and HTML Help pages.  Major themes that come with
00073 # Sphinx are currently 'default' and 'sphinxdoc'.
00074 html_theme = 'sphinxdoc'
00075 
00076 # Theme options are theme-specific and customize the look and feel of a theme
00077 # further.  For a list of options available for each theme, see the
00078 # documentation.
00079 # html_theme_options = { 'rightsidebar' : 'true' }
00080 
00081 # Add any paths that contain custom themes here, relative to this directory.
00082 html_theme_path = ['.']
00083 
00084 # The name for this set of Sphinx documents.  If None, it defaults to
00085 # "<project> v<release> documentation".
00086 html_title = None
00087 
00088 # A shorter title for the navigation bar.  Default is the same as html_title.
00089 html_short_title = 'Home'
00090 
00091 # The name of an image file (within the static path) to use as favicon of the
00092 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
00093 # pixels large.
00094 html_favicon = None
00095 
00096 # Add any paths that contain custom static files (such as style sheets) here,
00097 # relative to this directory. They are copied after the builtin static files,
00098 # so a file named "default.css" will overwrite the builtin "default.css".
00099 html_static_path = ['_static']
00100 
00101 # If true, SmartyPants will be used to convert quotes and dashes to
00102 # typographically correct entities.
00103 #html_use_smartypants = True
00104 
00105 # If false, no module index is generated.
00106 html_use_modindex = False
00107 
00108 # If false, no index is generated.
00109 html_use_index = False
00110 
00111 # If true, the index is split into individual pages for each letter.
00112 html_split_index = False
00113 
00114 # If true, links to the reST sources are added to the pages.
00115 html_show_sourcelink = False
00116 
00117 # If true, an OpenSearch description file will be output, and all pages will
00118 # contain a <link> tag referring to it.  The value of this option must be the
00119 # base URL from which the finished HTML is served.
00120 #html_use_opensearch = ''
00121 
00122 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
00123 html_file_suffix = '.html'
00124 
00125 html_sidebars = {
00126     '**': [],
00127     'using/windows': [],
00128 }
00129 html_show_copyright = False
00130 html_show_sphinx = False
00131 html_add_permalinks = None
00132 needs_sphinx = 1.0
00133 file_insertion_enabled = True
00134 raw_enabled = True
00135 # Set up doxylink
00136 doxylink = {'pcl' : ('../../../build/doc/doxygen/pcl.tag', 'http://docs.pointclouds.org/trunk/')}


pcl
Author(s): Open Perception
autogenerated on Wed Aug 26 2015 15:22:55