1# All configuration values have a default; values that are commented out
2# serve to show the default.
3
4# -- General configuration -----------------------------------------------------
5# Add any Sphinx extension module names here, as strings. They can be extensions
6# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
7extensions = ['sphinx.ext.imgmath', 'sphinxcontrib.doxylink.doxylink']
8
9# Add any paths that contain templates here, relative to this directory.
10# templates_path = ['_templates']
11
12# The suffix of source filenames.
13source_suffix = '.rst'
14
15# The master toctree document.
16master_doc = 'index'
17
18# General information about the project.
19project = u'Point Cloud Library'
20copyright = ''
21
22# The version info for the project you're documenting, acts as replacement for
23# |version| and |release|, also used in various other places throughout the
24# built documents.
25#
26# The short X.Y version.
27version = '0.0'
28# The full version, including alpha/beta/rc tags.
29release = '0.0'
30
31# The language for content autogenerated by Sphinx. Refer to documentation
32# for a list of supported languages.
33#language = None
34
35# There are two options for replacing |today|: either, you set today to some
36# non-false value, then it is used:
37#today = ''
38# Else, today_fmt is used as the format for a strftime call.
39#today_fmt = '%B %d, %Y'
40
41# List of documents that shouldn't be included in the build.
42#unused_docs = []
43
44# List of directories, relative to source directory, that shouldn't be searched
45# for source files.
46exclude_trees = []
47
48# The reST default role (used for this markup: `text`) to use for all documents.
49default_role = None
50
51# If true, '()' will be appended to :func: etc. cross-reference text.
52#add_function_parentheses = True
53
54# If true, the current module name will be prepended to all description
55# unit titles (such as .. function::).
56add_module_names = False
57
58# If true, sectionauthor and moduleauthor directives will be shown in the
59# output. They are ignored by default.
60show_authors = False
61
62# The name of the Pygments (syntax highlighting) style to use.
63pygments_style = 'sphinx'
64
65# A list of ignored prefixes for module index sorting.
66#modindex_common_prefix = []
67
68# -- Options for HTML output ---------------------------------------------------
69
70# The theme to use for HTML and HTML Help pages.  Major themes that come with
71# Sphinx are currently 'default' and 'sphinxdoc'.
72html_theme = 'sphinx_rtd_theme'
73
74# Theme options are theme-specific and customize the look and feel of a theme
75# further.  For a list of options available for each theme, see the
76# documentation.
77# html_theme_options = { 'rightsidebar' : 'true' }
78
79# Add any paths that contain custom themes here, relative to this directory.
80html_theme_path = ['.']
81
82# The name for this set of Sphinx documents.  If None, it defaults to
83# "<project> v<release> documentation".
84html_title = None
85
86# A shorter title for the navigation bar.  Default is the same as html_title.
87html_short_title = 'Home'
88
89# The name of an image file (within the static path) to use as favicon of the
90# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
91# pixels large.
92html_favicon = None
93
94# Add any paths that contain custom static files (such as style sheets) here,
95# relative to this directory. They are copied after the builtin static files,
96# so a file named "default.css" will overwrite the builtin "default.css".
97html_static_path = ['_static']
98
99# If true, SmartyPants will be used to convert quotes and dashes to
100# typographically correct entities.
101#html_use_smartypants = True
102
103# If false, no module index is generated.
104html_use_modindex = False
105
106# If false, no index is generated.
107html_use_index = True
108
109# If true, the index is split into individual pages for each letter.
110html_split_index = False
111
112# If true, links to the reST sources are added to the pages.
113html_show_sourcelink = False
114
115# If true, an OpenSearch description file will be output, and all pages will
116# contain a <link> tag referring to it.  The value of this option must be the
117# base URL from which the finished HTML is served.
118#html_use_opensearch = ''
119
120# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
121html_file_suffix = '.html'
122html_show_copyright = True
123html_show_sphinx = True
124html_add_permalinks = None
125needs_sphinx = '1.0'
126file_insertion_enabled = True
127raw_enabled = True
128# Set up doxylink
129doxylink = {'pcl' : ('../../../build/doc/doxygen/pcl.tag', 'http://docs.pointclouds.org/trunk/')}
130