1 # -*- coding: utf-8 -*-
3 # Debian Package Repository documentation build configuration file, created by
4 # sphinx-quickstart on Sat Mar 28 17:08:58 2009.
6 # This file is execfile()d with the current directory set to its containing dir.
8 # The contents of this file are pickled, so don't put values in the namespace
9 # that aren't pickleable (module imports are okay, they're removed automatically).
11 # Note that not all possible configuration values are present in this
14 # All configuration values have a default; values that are commented out
15 # serve to show the default.
19 # If your extensions are in another directory, add it here. If the directory
20 # is relative to the documentation root, use os.path.abspath to make it
21 # absolute, like shown here.
22 #sys.path.append(os.path.abspath('.'))
25 """Look into every parent dir for 'artwork' and return its relative path."""
28 target = os.path.join(*([os.path.pardir] * level + ['artwork']))
29 if os.path.isdir(target):
33 # if there is no way up
34 if os.path.abspath(os.path.join(*([os.path.pardir] * level))) == \
35 os.path.abspath(os.path.join(*([os.path.pardir] * (level + 1)))):
36 raise(ValueError, "Cannot find 'artwork'.")
39 # General configuration
40 # ---------------------
42 # Add any Sphinx extension module names here, as strings. They can be extensions
43 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
45 sys.path.append(os.path.abspath('.'))
46 extensions = ['ext.quote']
48 # Add any paths that contain templates here, relative to this directory.
49 templates_path = ['_templates']
51 # The suffix of source filenames.
52 source_suffix = '.rst'
54 # The encoding of source files.
55 #source_encoding = 'utf-8'
57 # The master toctree document.
60 # General information about the project.
61 project = u'Debian Neuroscience Package Repository'
62 copyright = u'2009-2010, NeuroDebian Team'
64 # The version info for the project you're documenting, acts as replacement for
65 # |version| and |release|, also used in various other places throughout the
68 # The short X.Y version.
70 # The full version, including alpha/beta/rc tags.
73 # The language for content autogenerated by Sphinx. Refer to documentation
74 # for a list of supported languages.
77 # There are two options for replacing |today|: either, you set today to some
78 # non-false value, then it is used:
80 # Else, today_fmt is used as the format for a strftime call.
81 today_fmt = '%B %d, %Y'
83 # List of documents that shouldn't be included in the build.
86 # List of directories, relative to source directory, that shouldn't be searched
88 exclude_trees = ['pkgs_addenum']
90 # The reST default role (used for this markup: `text`) to use for all documents.
93 # If true, '()' will be appended to :func: etc. cross-reference text.
94 #add_function_parentheses = True
96 # If true, the current module name will be prepended to all description
97 # unit titles (such as .. function::).
98 #add_module_names = True
100 # If true, sectionauthor and moduleauthor directives will be shown in the
101 # output. They are ignored by default.
102 #show_authors = False
104 # The name of the Pygments (syntax highlighting) style to use.
105 pygments_style = 'sphinx'
108 # Options for HTML output
109 # -----------------------
111 # The style sheet to use for HTML and HTML Help pages. A file of that name
112 # must exist either in Sphinx' static/ path, or in one of the custom paths
113 # given in html_static_path.
114 html_style = 'neurodebian.css'
116 # The name for this set of Sphinx documents. If None, it defaults to
117 # "<project> v<release> documentation".
120 # A shorter title for the navigation bar. Default is the same as html_title.
121 #html_short_title = "Debian Neuroscience"
123 # The name of an image file (relative to this directory) to place at the top
125 html_logo = os.path.join(artworkdir(), 'logo_tuned/fmri_w200.png')
127 # The name of an image file (within the static path) to use as favicon of the
128 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
130 html_favicon = 'favicon.ico'
132 # Add any paths that contain custom static files (such as style sheets) here,
133 # relative to this directory. They are copied after the builtin static files,
134 # so a file named "default.css" will overwrite the builtin "default.css".
135 html_static_path = ['_static']
137 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
138 # using the given strftime format.
139 #html_last_updated_fmt = '%b %d, %Y'
141 # If true, SmartyPants will be used to convert quotes and dashes to
142 # typographically correct entities.
143 #html_use_smartypants = True
145 # Custom sidebar templates, maps document names to template names.
148 # Additional templates that should be rendered to pages, maps page names to
150 #html_additional_pages = {}
152 # If false, no module index is generated.
153 html_use_modindex = False
155 # If false, no index is generated.
156 html_use_index = False
158 # If true, the index is split into individual pages for each letter.
159 #html_split_index = False
161 # If true, the reST sources are included in the HTML build as _sources/<name>.
162 html_copy_source = False
164 # If true, an OpenSearch description file will be output, and all pages will
165 # contain a <link> tag referring to it. The value of this option must be the
166 # base URL from which the finished HTML is served.
167 #html_use_opensearch = ''
169 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
170 #html_file_suffix = ''
172 # Output file base name for HTML help builder.
173 htmlhelp_basename = 'debpkgrepo'
176 # Options for LaTeX output
177 # ------------------------
179 # The paper size ('letter' or 'a4').
180 #latex_paper_size = 'letter'
182 # The font size ('10pt', '11pt' or '12pt').
183 #latex_font_size = '10pt'
185 # Grouping the document tree into LaTeX files. List of tuples
186 # (source start file, target name, title, author, document class [howto/manual]).
188 ('index', 'DebianPackageRepository.tex', ur'Debian Package Repository Documentation',
189 ur'Michael Hanke', 'manual'),
192 # The name of an image file (relative to this directory) to place at the top of
196 # For "manual" documents, if this is true, then toplevel headings are parts,
198 #latex_use_parts = False
200 # Additional stuff for the LaTeX preamble.
203 # Documents to append as an appendix to all manuals.
204 #latex_appendices = []
206 # If false, no module index is generated.
207 #latex_use_modindex = True