|
3 | 3 | # Freeseer documentation build configuration file, created by
|
4 | 4 | # sphinx-quickstart on Sun Sep 4 18:21:52 2011.
|
5 | 5 | #
|
6 |
| -# This file is execfile()d with the current directory set to its containing dir. |
7 |
| -# |
8 | 6 | # Note that not all possible configuration values are present in this
|
9 | 7 | # autogenerated file.
|
10 | 8 | #
|
|
18 | 16 | # add these directories to sys.path here.
|
19 | 17 | sys.path.append('../src') # Temporarily add freeseer/src to $PATH.
|
20 | 18 |
|
21 |
| -# -- General configuration ----------------------------------------------------- |
| 19 | +# -- General configuration ---------------------------------------------------- |
22 | 20 |
|
23 | 21 | # If your documentation needs a minimal Sphinx version, state it here.
|
24 | 22 | #needs_sphinx = '1.0'
|
25 | 23 |
|
26 |
| -# Add any Sphinx extension module names here, as strings. They can be extensions |
27 |
| -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
28 |
| -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.viewcode', |
29 |
| - 'sphinx.ext.todo'] |
| 24 | +# Add any Sphinx extension module names here, as strings. They can be |
| 25 | +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
| 26 | +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', |
| 27 | + 'sphinx.ext.viewcode', 'sphinx.ext.todo'] |
30 | 28 |
|
31 | 29 | # If True, the todo and todolist directives will produce output.
|
32 | 30 | # http://sphinx.pocoo.org/ext/todo.html#module-sphinx.ext.todo
|
33 |
| -todo_include_todos=True |
| 31 | +todo_include_todos = True |
34 | 32 |
|
35 | 33 | # Add any paths that contain templates here, relative to this directory.
|
36 | 34 | templates_path = ['_templates']
|
|
71 | 69 | # directories to ignore when looking for source files.
|
72 | 70 | exclude_patterns = ['contribute/packaging.rst']
|
73 | 71 |
|
74 |
| -# The reST default role (used for this markup: `text`) to use for all documents. |
| 72 | +# The reST default role (for text `like this`) to use for all documents. |
75 | 73 | #default_role = None
|
76 | 74 |
|
77 | 75 | # If true, '()' will be appended to :func: etc. cross-reference text.
|
|
92 | 90 | #modindex_common_prefix = []
|
93 | 91 |
|
94 | 92 |
|
95 |
| -# -- Options for HTML output --------------------------------------------------- |
| 93 | +# -- Options for HTML output -------------------------------------------------- |
96 | 94 |
|
97 | 95 | # The theme to use for HTML and HTML Help pages. See the documentation for
|
98 | 96 | # a list of builtin themes.
|
|
172 | 170 | htmlhelp_basename = 'Freeseerdoc'
|
173 | 171 |
|
174 | 172 |
|
175 |
| -# -- Options for LaTeX output -------------------------------------------------- |
| 173 | +# -- Options for LaTeX output ------------------------------------------------- |
176 | 174 |
|
177 | 175 | # The paper size ('letter' or 'a4').
|
178 | 176 | #latex_paper_size = 'letter'
|
179 | 177 |
|
180 | 178 | # The font size ('10pt', '11pt' or '12pt').
|
181 | 179 | #latex_font_size = '10pt'
|
182 | 180 |
|
183 |
| -# Grouping the document tree into LaTeX files. List of tuples |
184 |
| -# (source start file, target name, title, author, documentclass [howto/manual]). |
185 |
| -latex_documents = [ |
186 |
| - ('index', 'Freeseer.tex', u'Freeseer Documentation', |
187 |
| - u'Free and Open Source Software Learning Centre', 'manual'), |
188 |
| -] |
| 181 | +# Grouping the document tree into LaTeX files. Takes a list of tuples. |
| 182 | +latex_documents = [( |
| 183 | + 'index', # source start file |
| 184 | + 'Freeseer.tex', # target name |
| 185 | + u'Freeseer Documentation', # title |
| 186 | + u'Free and Open Source Software Learning Centre', # author |
| 187 | + 'manual' # documentclass [howto/manual] |
| 188 | +)] |
189 | 189 |
|
190 | 190 | # The name of an image file (relative to this directory) to place at the top of
|
191 | 191 | # the title page.
|
|
211 | 211 | #latex_domain_indices = True
|
212 | 212 |
|
213 | 213 |
|
214 |
| -# -- Options for manual page output -------------------------------------------- |
| 214 | +# -- Options for manual page output ------------------------------------------- |
215 | 215 |
|
216 | 216 | # One entry per manual page. List of tuples
|
217 | 217 | # (source start file, name, description, authors, manual section).
|
|
0 commit comments