Commit | Line | Data |
---|---|---|
3eae167e WKG |
1 | # -*- coding: utf-8 -*- |
2 | # | |
3 | # GNU MediaGoblin documentation build configuration file, created by | |
4 | # sphinx-quickstart on Thu Apr 7 20:10:27 2011. | |
5 | # | |
6 | # This file is execfile()d with the current directory set to its containing dir. | |
7 | # | |
8 | # Note that not all possible configuration values are present in this | |
9 | # autogenerated file. | |
10 | # | |
11 | # All configuration values have a default; values that are commented out | |
12 | # serve to show the default. | |
13 | ||
14 | import sys, os | |
15 | ||
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. | |
9610848c | 19 | sys.path.insert(0, os.path.abspath('.')) |
9454f6c8 | 20 | sys.path.insert(0, os.path.abspath(os.path.join('..', '..'))) |
3eae167e WKG |
21 | |
22 | # -- General configuration ----------------------------------------------------- | |
23 | ||
24 | # If your documentation needs a minimal Sphinx version, state it here. | |
25 | #needs_sphinx = '1.0' | |
26 | ||
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. | |
f8107ccc JW |
29 | extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx'] |
30 | intersphinx_mapping = {'python': ('http://docs.python.org/2.7', None)} | |
3eae167e WKG |
31 | |
32 | # Add any paths that contain templates here, relative to this directory. | |
a46f645e | 33 | templates_path = ['source/_templates'] |
3eae167e WKG |
34 | |
35 | # The suffix of source filenames. | |
36 | source_suffix = '.rst' | |
37 | ||
38 | # The encoding of source files. | |
39 | #source_encoding = 'utf-8-sig' | |
40 | ||
41 | # The master toctree document. | |
42 | master_doc = 'index' | |
43 | ||
44 | # General information about the project. | |
45 | project = u'GNU MediaGoblin' | |
58301e09 | 46 | copyright = u'2011, 2012 GNU MediaGoblin contributors' |
3eae167e WKG |
47 | |
48 | # The version info for the project you're documenting, acts as replacement for | |
49 | # |version| and |release|, also used in various other places throughout the | |
50 | # built documents. | |
51 | # | |
9454f6c8 WKG |
52 | try: |
53 | from mediagoblin._version import __version__ | |
54 | # The short X.Y version. | |
55 | version = '.'.join(__version__.split('.')[0:2]) | |
56 | # The full version, including alpha/beta/rc tags. | |
57 | release = __version__ | |
58 | except ImportError: | |
59 | version = 'unknown' | |
60 | release = 'unknown' | |
3eae167e WKG |
61 | |
62 | # The language for content autogenerated by Sphinx. Refer to documentation | |
63 | # for a list of supported languages. | |
64 | #language = None | |
65 | ||
66 | # There are two options for replacing |today|: either, you set today to some | |
67 | # non-false value, then it is used: | |
68 | #today = '' | |
69 | # Else, today_fmt is used as the format for a strftime call. | |
70 | #today_fmt = '%B %d, %Y' | |
71 | ||
72 | # List of patterns, relative to source directory, that match files and | |
73 | # directories to ignore when looking for source files. | |
25a7eb25 | 74 | exclude_patterns = ['_build', 'mgext', '_templates', '_static'] |
3eae167e WKG |
75 | |
76 | # The reST default role (used for this markup: `text`) to use for all documents. | |
77 | #default_role = None | |
78 | ||
79 | # If true, '()' will be appended to :func: etc. cross-reference text. | |
80 | #add_function_parentheses = True | |
81 | ||
82 | # If true, the current module name will be prepended to all description | |
83 | # unit titles (such as .. function::). | |
84 | #add_module_names = True | |
85 | ||
86 | # If true, sectionauthor and moduleauthor directives will be shown in the | |
87 | # output. They are ignored by default. | |
88 | #show_authors = False | |
89 | ||
90 | # The name of the Pygments (syntax highlighting) style to use. | |
91 | pygments_style = 'sphinx' | |
92 | ||
93 | # A list of ignored prefixes for module index sorting. | |
94 | #modindex_common_prefix = [] | |
95 | ||
96 | ||
97 | # -- Options for HTML output --------------------------------------------------- | |
98 | ||
99 | # The theme to use for HTML and HTML Help pages. See the documentation for | |
100 | # a list of builtin themes. | |
a46f645e WKG |
101 | # html_theme = 'default' |
102 | html_theme = 'mg' | |
3eae167e WKG |
103 | |
104 | # Theme options are theme-specific and customize the look and feel of a theme | |
105 | # further. For a list of options available for each theme, see the | |
106 | # documentation. | |
107 | #html_theme_options = {} | |
108 | ||
109 | # Add any paths that contain custom themes here, relative to this directory. | |
a46f645e | 110 | html_theme_path = ['themes'] |
3eae167e WKG |
111 | |
112 | # The name for this set of Sphinx documents. If None, it defaults to | |
113 | # "<project> v<release> documentation". | |
114 | #html_title = None | |
115 | ||
116 | # A shorter title for the navigation bar. Default is the same as html_title. | |
117 | #html_short_title = None | |
118 | ||
119 | # The name of an image file (relative to this directory) to place at the top | |
120 | # of the sidebar. | |
b957cba0 | 121 | html_logo = 'logo_docs.png' |
3eae167e WKG |
122 | |
123 | # The name of an image file (within the static path) to use as favicon of the | |
124 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 | |
125 | # pixels large. | |
126 | #html_favicon = None | |
127 | ||
128 | # Add any paths that contain custom static files (such as style sheets) here, | |
129 | # relative to this directory. They are copied after the builtin static files, | |
130 | # so a file named "default.css" will overwrite the builtin "default.css". | |
131 | html_static_path = ['_static'] | |
132 | ||
133 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | |
134 | # using the given strftime format. | |
135 | #html_last_updated_fmt = '%b %d, %Y' | |
136 | ||
137 | # If true, SmartyPants will be used to convert quotes and dashes to | |
138 | # typographically correct entities. | |
139 | #html_use_smartypants = True | |
140 | ||
141 | # Custom sidebar templates, maps document names to template names. | |
142 | #html_sidebars = {} | |
143 | ||
144 | # Additional templates that should be rendered to pages, maps page names to | |
145 | # template names. | |
146 | #html_additional_pages = {} | |
147 | ||
148 | # If false, no module index is generated. | |
149 | #html_domain_indices = True | |
150 | ||
151 | # If false, no index is generated. | |
152 | #html_use_index = True | |
153 | ||
154 | # If true, the index is split into individual pages for each letter. | |
155 | #html_split_index = False | |
156 | ||
157 | # If true, links to the reST sources are added to the pages. | |
158 | #html_show_sourcelink = True | |
159 | ||
160 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. | |
161 | #html_show_sphinx = True | |
162 | ||
163 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. | |
164 | #html_show_copyright = True | |
165 | ||
166 | # If true, an OpenSearch description file will be output, and all pages will | |
167 | # contain a <link> tag referring to it. The value of this option must be the | |
168 | # base URL from which the finished HTML is served. | |
169 | #html_use_opensearch = '' | |
170 | ||
171 | # This is the file name suffix for HTML files (e.g. ".xhtml"). | |
172 | #html_file_suffix = None | |
173 | ||
174 | # Output file base name for HTML help builder. | |
175 | htmlhelp_basename = 'GNUMediaGoblindoc' | |
176 | ||
177 | ||
178 | # -- Options for LaTeX output -------------------------------------------------- | |
179 | ||
180 | # The paper size ('letter' or 'a4'). | |
181 | #latex_paper_size = 'letter' | |
182 | ||
183 | # The font size ('10pt', '11pt' or '12pt'). | |
184 | #latex_font_size = '10pt' | |
185 | ||
186 | # Grouping the document tree into LaTeX files. List of tuples | |
187 | # (source start file, target name, title, author, documentclass [howto/manual]). | |
188 | latex_documents = [ | |
189 | ('index', 'GNUMediaGoblin.tex', u'GNU MediaGoblin Documentation', | |
190 | u'Chris Webber, et al', 'manual'), | |
191 | ] | |
192 | ||
193 | # The name of an image file (relative to this directory) to place at the top of | |
194 | # the title page. | |
195 | #latex_logo = None | |
196 | ||
197 | # For "manual" documents, if this is true, then toplevel headings are parts, | |
198 | # not chapters. | |
199 | #latex_use_parts = False | |
200 | ||
201 | # If true, show page references after internal links. | |
202 | #latex_show_pagerefs = False | |
203 | ||
204 | # If true, show URL addresses after external links. | |
205 | #latex_show_urls = False | |
206 | ||
207 | # Additional stuff for the LaTeX preamble. | |
208 | #latex_preamble = '' | |
209 | ||
210 | # Documents to append as an appendix to all manuals. | |
211 | #latex_appendices = [] | |
212 | ||
213 | # If false, no module index is generated. | |
214 | #latex_domain_indices = True | |
215 | ||
216 | ||
217 | # -- Options for manual page output -------------------------------------------- | |
218 | ||
219 | # One entry per manual page. List of tuples | |
220 | # (source start file, name, description, authors, manual section). | |
221 | man_pages = [ | |
09e2db30 | 222 | ('index', 'mediagoblin', u'GNU MediaGoblin Documentation', |
3eae167e WKG |
223 | [u'Chris Webber, et al'], 1) |
224 | ] | |
d4535719 WKG |
225 | |
226 | # If true, show URL addresses after external links. | |
227 | #man_show_urls = False | |
228 | ||
229 | ||
230 | # -- Options for Texinfo output ------------------------------------------------ | |
231 | ||
232 | # Grouping the document tree into Texinfo files. List of tuples | |
233 | # (source start file, target name, title, author, | |
234 | # dir menu entry, description, category) | |
235 | texinfo_documents = [ | |
09e2db30 | 236 | ('index', 'mediagoblin', u'GNU MediaGoblin Documentation', u'mediagoblin', |
d4535719 WKG |
237 | 'GNU MediaGoblin', 'Media sharing web application.', 'Miscellaneous'), |
238 | ] | |
239 | ||
240 | # Documents to append as an appendix to all manuals. | |
241 | #texinfo_appendices = [] | |
242 | ||
243 | # If false, no module index is generated. | |
244 | #texinfo_domain_indices = True | |
245 | ||
246 | # How to display URL addresses: 'footnote', 'no', or 'inline'. | |
247 | #texinfo_show_urls = 'footnote' |