1 # -*- coding: utf-8 -*-
3 # CasparCG documentation build configuration file, created by
4 # sphinx-quickstart on Thu Dec 01 22:45:08 2011.
6 # This file is execfile()d with the current directory set to its containing dir.
8 # Note that not all possible configuration values are present in this
11 # All configuration values have a default; values that are commented out
12 # serve to show the default.
15 sys.path.append(os.path.abspath('tools/sphinxext'))
17 # If extensions (or modules to document with autodoc) are in another directory,
18 # add these directories to sys.path here. If the directory is relative to the
19 # documentation root, use os.path.abspath to make it absolute, like shown here.
20 #sys.path.insert(0, os.path.abspath('.'))
22 # -- General configuration -----------------------------------------------------
24 # If your documentation needs a minimal Sphinx version, state it here.
27 # Add any Sphinx extension module names here, as strings. They can be extensions
28 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
30 templates_path = ['tools/sphinxext']
32 # The suffix of source filenames.
33 source_suffix = '.rst'
35 # The encoding of source files.
36 #source_encoding = 'utf-8-sig'
38 # The master toctree document.
41 # General information about the project.
43 copyright = u'2011, Robert Nagy (ronag89@gmail.com)'
45 # The version info for the project you're documenting, acts as replacement for
46 # |version| and |release|, also used in various other places throughout the
49 # The short X.Y version.
51 # The full version, including alpha/beta/rc tags.
54 # The language for content autogenerated by Sphinx. Refer to documentation
55 # for a list of supported languages.
58 # There are two options for replacing |today|: either, you set today to some
59 # non-false value, then it is used:
61 # Else, today_fmt is used as the format for a strftime call.
62 #today_fmt = '%B %d, %Y'
64 # List of patterns, relative to source directory, that match files and
65 # directories to ignore when looking for source files.
68 # The reST default role (used for this markup: `text`) to use for all documents.
71 # If true, '()' will be appended to :func: etc. cross-reference text.
72 #add_function_parentheses = True
74 # If true, the current module name will be prepended to all description
75 # unit titles (such as .. function::).
76 #add_module_names = True
78 # If true, sectionauthor and moduleauthor directives will be shown in the
79 # output. They are ignored by default.
82 # The name of the Pygments (syntax highlighting) style to use.
83 pygments_style = 'sphinx'
85 # A list of ignored prefixes for module index sorting.
86 #modindex_common_prefix = []
89 # -- Options for HTML output ---------------------------------------------------
90 sys.path.append(os.path.abspath('_themes'))
91 html_theme_path = ['_themes']
93 html_theme = 'default'
94 html_theme_options = {'collapsiblesidebar': True}
96 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
97 # using the given strftime format.
98 html_last_updated_fmt = '%b %d, %Y'
100 # If true, SmartyPants will be used to convert quotes and dashes to
101 # typographically correct entities.
102 html_use_smartypants = True
104 # Custom sidebar templates, filenames relative to this file.
106 # Additional templates that should be rendered to pages.
107 html_additional_pages = {
108 'index': 'indexcontent.html',
111 # Output an OpenSearch description file.
112 html_use_opensearch = 'http://docs.python.org/dev/py3k'
114 # Additional static files.
116 # Output file base name for HTML help builder.
117 htmlhelp_basename = 'python' + release.replace('.', '')
120 html_split_index = True
123 # -- Options for LaTeX output --------------------------------------------------
126 # The paper size ('letterpaper' or 'a4paper').
127 #'papersize': 'letterpaper',
129 # The font size ('10pt', '11pt' or '12pt').
130 #'pointsize': '10pt',
132 # Additional stuff for the LaTeX preamble.
136 # Grouping the document tree into LaTeX files. List of tuples
137 # (source start file, target name, title, author, documentclass [howto/manual]).
139 ('index', 'CasparCG.tex', u'CasparCG Documentation',
140 u'Robert Nagy', 'manual'),
143 # The name of an image file (relative to this directory) to place at the top of
147 # For "manual" documents, if this is true, then toplevel headings are parts,
149 #latex_use_parts = False
151 # If true, show page references after internal links.
152 #latex_show_pagerefs = False
154 # If true, show URL addresses after external links.
155 #latex_show_urls = False
157 # Documents to append as an appendix to all manuals.
158 #latex_appendices = []
160 # If false, no module index is generated.
161 #latex_domain_indices = True
164 # -- Options for manual page output --------------------------------------------
166 # One entry per manual page. List of tuples
167 # (source start file, name, description, authors, manual section).
169 ('index', 'casparcg', u'CasparCG Documentation',
173 # If true, show URL addresses after external links.
174 #man_show_urls = False
177 # -- Options for Texinfo output ------------------------------------------------
179 # Grouping the document tree into Texinfo files. List of tuples
180 # (source start file, target name, title, author,
181 # dir menu entry, description, category)
182 texinfo_documents = [
183 ('index', 'CasparCG', u'CasparCG Documentation',
184 u'Robert Nagy', 'CasparCG', 'One line description of project.',
188 # Documents to append as an appendix to all manuals.
189 #texinfo_appendices = []
191 # If false, no module index is generated.
192 #texinfo_domain_indices = True
194 # How to display URL addresses: 'footnote', 'no', or 'inline'.
195 #texinfo_show_urls = 'footnote'