Mercurial > pyntnclick

comparison docs/conf.py @ 538:d1b86d5849a0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
More pep8 cleanups
author Neil Muller <neil@dip.sun.ac.za>
date Sat, 11 Feb 2012 12:15:31 +0200
parents 3794e7f4093e
children 0740f6a537ea
comparison
equal deleted inserted replaced
537:5b9f371c2bb8 538:d1b86d5849a0
1 # -*- coding: utf-8 -*- 1 # -*- coding: utf-8 -*-
2 # 2 #
3 # Boomslang documentation build configuration file, created by 3 # Boomslang documentation build configuration file, created by
4 # sphinx-quickstart on Mon Aug 23 00:49:49 2010. 4 # sphinx-quickstart on Mon Aug 23 00:49:49 2010.
5 # 5 #
6 # This file is execfile()d with the current directory set to its containing dir. 6 # This file is execfile()d with the current directory set to its containing
7 # dir.
7 # 8 #
8 # Note that not all possible configuration values are present in this 9 # Note that not all possible configuration values are present in this
9 # autogenerated file. 10 # autogenerated file.
10 # 11 #
11 # All configuration values have a default; values that are commented out 12 # All configuration values have a default; values that are commented out
12 # serve to show the default. 13 # serve to show the default.
13 14
14 import sys, os 15 import sys
16 import os
15 17
16 # If extensions (or modules to document with autodoc) are in another directory, 18 # 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 19 # 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. 20 # documentation root, use os.path.abspath to make it absolute, like shown here.
19 #sys.path.insert(0, os.path.abspath('.')) 21 #sys.path.insert(0, os.path.abspath('.'))
20 22
21 # -- General configuration ----------------------------------------------------- 23 # -- General configuration ----------------------------------------------------
22 24
23 # If your documentation needs a minimal Sphinx version, state it here. 25 # If your documentation needs a minimal Sphinx version, state it here.
24 #needs_sphinx = '1.0' 26 #needs_sphinx = '1.0'
25 27
26 # Add any Sphinx extension module names here, as strings. They can be extensions 28 # Add any Sphinx extension module names here, as strings. They can be
27 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 29 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
28 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo'] 30 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo']
29 31
30 # Add any paths that contain templates here, relative to this directory. 32 # Add any paths that contain templates here, relative to this directory.
31 templates_path = ['_templates'] 33 templates_path = ['_templates']
32 34
39 # The master toctree document. 41 # The master toctree document.
40 master_doc = 'index' 42 master_doc = 'index'
41 43
42 # General information about the project. 44 # General information about the project.
43 project = u'Boomslang' 45 project = u'Boomslang'
44 copyright = u'2010, Simon Cross, Adrianna Pinska, Jeremy Thurgood, Neil Muller, Stefano Rivera' 46 copyright = u'2010, Simon Cross, Adrianna Pinska, Jeremy Thurgood,' \
47 ' Neil Muller, Stefano Rivera'
45 48
46 # The version info for the project you're documenting, acts as replacement for 49 # The version info for the project you're documenting, acts as replacement for
47 # |version| and |release|, also used in various other places throughout the 50 # |version| and |release|, also used in various other places throughout the
48 # built documents. 51 # built documents.
49 # 52 #
64 67
65 # List of patterns, relative to source directory, that match files and 68 # List of patterns, relative to source directory, that match files and
66 # directories to ignore when looking for source files. 69 # directories to ignore when looking for source files.
67 exclude_patterns = ['_build'] 70 exclude_patterns = ['_build']
68 71
69 # The reST default role (used for this markup: `text`) to use for all documents. 72 # The reST default role (used for this markup: `text`) to use for all
73 # documents.
70 #default_role = None 74 #default_role = None
71 75
72 # If true, '()' will be appended to :func: etc. cross-reference text. 76 # If true, '()' will be appended to :func: etc. cross-reference text.
73 #add_function_parentheses = True 77 #add_function_parentheses = True
74 78
84 pygments_style = 'sphinx' 88 pygments_style = 'sphinx'
85 89
86 # A list of ignored prefixes for module index sorting. 90 # A list of ignored prefixes for module index sorting.
87 #modindex_common_prefix = [] 91 #modindex_common_prefix = []
88 92
89 93 # -- Options for HTML output --------------------------------------------------
90 # -- Options for HTML output ---------------------------------------------------
91 94
92 # The theme to use for HTML and HTML Help pages. See the documentation for 95 # The theme to use for HTML and HTML Help pages. See the documentation for
93 # a list of builtin themes. 96 # a list of builtin themes.
94 html_theme = 'default' 97 html_theme = 'default'
95 98
165 168
166 # Output file base name for HTML help builder. 169 # Output file base name for HTML help builder.
167 htmlhelp_basename = 'Boomslangdoc' 170 htmlhelp_basename = 'Boomslangdoc'
168 171
169 172
170 # -- Options for LaTeX output -------------------------------------------------- 173 # -- Options for LaTeX output -------------------------------------------------
171 174
172 # The paper size ('letter' or 'a4'). 175 # The paper size ('letter' or 'a4').
173 #latex_paper_size = 'letter' 176 #latex_paper_size = 'letter'
174 177
175 # The font size ('10pt', '11pt' or '12pt'). 178 # The font size ('10pt', '11pt' or '12pt').
176 #latex_font_size = '10pt' 179 #latex_font_size = '10pt'
177 180
178 # Grouping the document tree into LaTeX files. List of tuples 181 # Grouping the document tree into LaTeX files. List of tuples
179 # (source start file, target name, title, author, documentclass [howto/manual]). 182 # (source start file, target name, title, author, documentclass
183 # [howto/manual]).
180 latex_documents = [ 184 latex_documents = [
181 ('index', 'Boomslang.tex', u'Boomslang Documentation', 185 ('index', 'Boomslang.tex', u'Boomslang Documentation',
182 u'Simon Cross, Adrianna Pinska, Jeremy Thurgood, Neil Muller, Stefano Rivera', 'manual'), 186 u'Simon Cross, Adrianna Pinska, Jeremy Thurgood, Neil Muller,'
187 ' Stefano Rivera', 'manual'),
183 ] 188 ]
184 189
185 # The name of an image file (relative to this directory) to place at the top of 190 # The name of an image file (relative to this directory) to place at the top of
186 # the title page. 191 # the title page.
187 #latex_logo = None 192 #latex_logo = None
204 209
205 # If false, no module index is generated. 210 # If false, no module index is generated.
206 #latex_domain_indices = True 211 #latex_domain_indices = True
207 212
208 213
209 # -- Options for manual page output -------------------------------------------- 214 # -- Options for manual page output -------------------------------------------
210 215
211 # One entry per manual page. List of tuples 216 # One entry per manual page. List of tuples
212 # (source start file, name, description, authors, manual section). 217 # (source start file, name, description, authors, manual section).
213 man_pages = [ 218 man_pages = [
214 ('index', 'boomslang', u'Boomslang Documentation', 219 ('index', 'boomslang', u'Boomslang Documentation',
215 [u'Simon Cross, Adrianna Pinska, Jeremy Thurgood, Neil Muller, Stefano Rivera'], 1) 220 [u'Simon Cross, Adrianna Pinska, Jeremy Thurgood, Neil Muller,''
221 Stefano Rivera'], 1)
216 ] 222 ]