1 # -*- coding: utf-8 -*-
3 # GNU MediaGoblin documentation build configuration file, created by
4 # sphinx-quickstart on Thu Apr 7 20:10:27 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.
16 # If extensions (or modules to document with autodoc) are in another directory,
17 # add these directories to sys.path here. If the directory is relative to the
18 # documentation root, use os.path.abspath to make it absolute, like shown here.
19 sys
.path
.insert(0, os
.path
.abspath('.'))
20 sys
.path
.insert(0, os
.path
.abspath(os
.path
.join('..', '..')))
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.
31 # Add any paths that contain templates here, relative to this directory.
32 templates_path
= ['source/_templates']
34 # The suffix of source filenames.
35 source_suffix
= '.rst'
37 # The encoding of source files.
38 #source_encoding = 'utf-8-sig'
40 # The master toctree document.
43 # General information about the project.
44 project
= u
'GNU MediaGoblin'
45 copyright
= u
'2011, 2012 GNU MediaGoblin contributors'
47 # The version info for the project you're documenting, acts as replacement for
48 # |version| and |release|, also used in various other places throughout the
52 from mediagoblin
._version
import __version__
53 # The short X.Y version.
54 version
= '.'.join(__version__
.split('.')[0:2])
55 # The full version, including alpha/beta/rc tags.
61 # The language for content autogenerated by Sphinx. Refer to documentation
62 # for a list of supported languages.
65 # There are two options for replacing |today|: either, you set today to some
66 # non-false value, then it is used:
68 # Else, today_fmt is used as the format for a strftime call.
69 #today_fmt = '%B %d, %Y'
71 # List of patterns, relative to source directory, that match files and
72 # directories to ignore when looking for source files.
73 exclude_patterns
= ['_build', 'mgext', '_templates', '_static']
75 # The reST default role (used for this markup: `text`) to use for all documents.
78 # If true, '()' will be appended to :func: etc. cross-reference text.
79 #add_function_parentheses = True
81 # If true, the current module name will be prepended to all description
82 # unit titles (such as .. function::).
83 #add_module_names = True
85 # If true, sectionauthor and moduleauthor directives will be shown in the
86 # output. They are ignored by default.
89 # The name of the Pygments (syntax highlighting) style to use.
90 pygments_style
= 'sphinx'
92 # A list of ignored prefixes for module index sorting.
93 #modindex_common_prefix = []
96 # -- Options for HTML output ---------------------------------------------------
98 # The theme to use for HTML and HTML Help pages. See the documentation for
99 # a list of builtin themes.
100 # html_theme = 'default'
103 # Theme options are theme-specific and customize the look and feel of a theme
104 # further. For a list of options available for each theme, see the
106 #html_theme_options = {}
108 # Add any paths that contain custom themes here, relative to this directory.
109 html_theme_path
= ['themes']
111 # The name for this set of Sphinx documents. If None, it defaults to
112 # "<project> v<release> documentation".
115 # A shorter title for the navigation bar. Default is the same as html_title.
116 #html_short_title = None
118 # The name of an image file (relative to this directory) to place at the top
120 html_logo
= 'logo_docs.png'
122 # The name of an image file (within the static path) to use as favicon of the
123 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
127 # Add any paths that contain custom static files (such as style sheets) here,
128 # relative to this directory. They are copied after the builtin static files,
129 # so a file named "default.css" will overwrite the builtin "default.css".
130 html_static_path
= ['_static']
132 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
133 # using the given strftime format.
134 #html_last_updated_fmt = '%b %d, %Y'
136 # If true, SmartyPants will be used to convert quotes and dashes to
137 # typographically correct entities.
138 #html_use_smartypants = True
140 # Custom sidebar templates, maps document names to template names.
143 # Additional templates that should be rendered to pages, maps page names to
145 #html_additional_pages = {}
147 # If false, no module index is generated.
148 #html_domain_indices = True
150 # If false, no index is generated.
151 #html_use_index = True
153 # If true, the index is split into individual pages for each letter.
154 #html_split_index = False
156 # If true, links to the reST sources are added to the pages.
157 #html_show_sourcelink = True
159 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
160 #html_show_sphinx = True
162 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
163 #html_show_copyright = True
165 # If true, an OpenSearch description file will be output, and all pages will
166 # contain a <link> tag referring to it. The value of this option must be the
167 # base URL from which the finished HTML is served.
168 #html_use_opensearch = ''
170 # This is the file name suffix for HTML files (e.g. ".xhtml").
171 #html_file_suffix = None
173 # Output file base name for HTML help builder.
174 htmlhelp_basename
= 'GNUMediaGoblindoc'
177 # -- Options for LaTeX output --------------------------------------------------
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, documentclass [howto/manual]).
188 ('index', 'GNUMediaGoblin.tex', u
'GNU MediaGoblin Documentation',
189 u
'Chris Webber, et al', '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 # If true, show page references after internal links.
201 #latex_show_pagerefs = False
203 # If true, show URL addresses after external links.
204 #latex_show_urls = False
206 # Additional stuff for the LaTeX preamble.
209 # Documents to append as an appendix to all manuals.
210 #latex_appendices = []
212 # If false, no module index is generated.
213 #latex_domain_indices = True
216 # -- Options for manual page output --------------------------------------------
218 # One entry per manual page. List of tuples
219 # (source start file, name, description, authors, manual section).
221 ('index', 'gnumediagoblin', u
'GNU MediaGoblin Documentation',
222 [u
'Chris Webber, et al'], 1)
225 # If true, show URL addresses after external links.
226 #man_show_urls = False
229 # -- Options for Texinfo output ------------------------------------------------
231 # Grouping the document tree into Texinfo files. List of tuples
232 # (source start file, target name, title, author,
233 # dir menu entry, description, category)
234 texinfo_documents
= [
235 ('index', 'gnumediagoblin', u
'GNU MediaGoblin Documentation', u
'gnumediagoblin',
236 'GNU MediaGoblin', 'Media sharing web application.', 'Miscellaneous'),
239 # Documents to append as an appendix to all manuals.
240 #texinfo_appendices = []
242 # If false, no module index is generated.
243 #texinfo_domain_indices = True
245 # How to display URL addresses: 'footnote', 'no', or 'inline'.
246 #texinfo_show_urls = 'footnote'