annotate docs/conf.py @ 324:21584174d865

make SHOW TABLES work
author catherine@dellzilla
date Thu, 11 Feb 2010 16:07:24 -0500
parents 0687bb650118
children
rev   line source
314
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
1 # -*- coding: utf-8 -*-
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
2 #
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
3 # cmd2 documentation build configuration file, created by
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
4 # sphinx-quickstart on Wed Feb 10 12:05:28 2010.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
5 #
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
6 # This file is execfile()d with the current directory set to its containing dir.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
7 #
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
8 # Note that not all possible configuration values are present in this
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
9 # autogenerated file.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
10 #
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
11 # All configuration values have a default; values that are commented out
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
12 # serve to show the default.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
13
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
14 import sys, os
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
15
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
16 # If extensions (or modules to document with autodoc) are in another directory,
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
17 # add these directories to sys.path here. If the directory is relative to the
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
18 # documentation root, use os.path.abspath to make it absolute, like shown here.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
19 #sys.path.append(os.path.abspath('.'))
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
20
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
21 # -- General configuration -----------------------------------------------------
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
22
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
23 # Add any Sphinx extension module names here, as strings. They can be extensions
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
24 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
25 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo']
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
26
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
27 # Add any paths that contain templates here, relative to this directory.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
28 templates_path = ['_templates']
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
29
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
30 # The suffix of source filenames.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
31 source_suffix = '.rst'
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
32
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
33 # The encoding of source files.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
34 #source_encoding = 'utf-8'
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
35
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
36 # The master toctree document.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
37 master_doc = 'index'
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
38
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
39 # General information about the project.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
40 project = u'cmd2'
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
41 copyright = u'2010, Catherine Devlin'
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
42
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
43 # The version info for the project you're documenting, acts as replacement for
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
44 # |version| and |release|, also used in various other places throughout the
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
45 # built documents.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
46 #
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
47 # The short X.Y version.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
48 version = '0.6.0'
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
49 # The full version, including alpha/beta/rc tags.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
50 release = '0.6.0'
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
51
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
52 # The language for content autogenerated by Sphinx. Refer to documentation
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
53 # for a list of supported languages.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
54 #language = None
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
55
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
56 # There are two options for replacing |today|: either, you set today to some
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
57 # non-false value, then it is used:
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
58 #today = ''
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
59 # Else, today_fmt is used as the format for a strftime call.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
60 #today_fmt = '%B %d, %Y'
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
61
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
62 # List of documents that shouldn't be included in the build.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
63 #unused_docs = []
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
64
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
65 # List of directories, relative to source directory, that shouldn't be searched
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
66 # for source files.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
67 exclude_trees = ['_build']
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
68
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
69 # The reST default role (used for this markup: `text`) to use for all documents.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
70 #default_role = None
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
71
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
72 # If true, '()' will be appended to :func: etc. cross-reference text.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
73 #add_function_parentheses = True
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
74
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
75 # If true, the current module name will be prepended to all description
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
76 # unit titles (such as .. function::).
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
77 #add_module_names = True
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
78
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
79 # If true, sectionauthor and moduleauthor directives will be shown in the
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
80 # output. They are ignored by default.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
81 #show_authors = False
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
82
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
83 # The name of the Pygments (syntax highlighting) style to use.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
84 pygments_style = 'sphinx'
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
85
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
86 # A list of ignored prefixes for module index sorting.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
87 #modindex_common_prefix = []
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
88
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
89
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
90 # -- Options for HTML output ---------------------------------------------------
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
91
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
92 # The theme to use for HTML and HTML Help pages. Major themes that come with
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
93 # Sphinx are currently 'default' and 'sphinxdoc'.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
94 html_theme = 'default'
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
95
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
96 # Theme options are theme-specific and customize the look and feel of a theme
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
97 # further. For a list of options available for each theme, see the
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
98 # documentation.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
99 #html_theme_options = {}
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
100
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
101 # Add any paths that contain custom themes here, relative to this directory.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
102 #html_theme_path = []
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
103
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
104 # The name for this set of Sphinx documents. If None, it defaults to
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
105 # "<project> v<release> documentation".
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
106 #html_title = None
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
107
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
108 # A shorter title for the navigation bar. Default is the same as html_title.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
109 #html_short_title = None
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
110
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
111 # The name of an image file (relative to this directory) to place at the top
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
112 # of the sidebar.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
113 #html_logo = None
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
114
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
115 # The name of an image file (within the static path) to use as favicon of the
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
116 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
117 # pixels large.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
118 #html_favicon = None
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
119
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
120 # Add any paths that contain custom static files (such as style sheets) here,
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
121 # relative to this directory. They are copied after the builtin static files,
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
122 # so a file named "default.css" will overwrite the builtin "default.css".
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
123 html_static_path = ['_static']
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
124
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
125 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
126 # using the given strftime format.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
127 #html_last_updated_fmt = '%b %d, %Y'
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
128
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
129 # If true, SmartyPants will be used to convert quotes and dashes to
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
130 # typographically correct entities.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
131 #html_use_smartypants = True
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
132
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
133 # Custom sidebar templates, maps document names to template names.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
134 #html_sidebars = {}
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
135
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
136 # Additional templates that should be rendered to pages, maps page names to
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
137 # template names.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
138 #html_additional_pages = {}
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
139
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
140 # If false, no module index is generated.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
141 #html_use_modindex = True
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
142
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
143 # If false, no index is generated.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
144 #html_use_index = True
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
145
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
146 # If true, the index is split into individual pages for each letter.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
147 #html_split_index = False
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
148
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
149 # If true, links to the reST sources are added to the pages.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
150 #html_show_sourcelink = True
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
151
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
152 # If true, an OpenSearch description file will be output, and all pages will
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
153 # contain a <link> tag referring to it. The value of this option must be the
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
154 # base URL from which the finished HTML is served.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
155 #html_use_opensearch = ''
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
156
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
157 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
158 #html_file_suffix = ''
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
159
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
160 # Output file base name for HTML help builder.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
161 htmlhelp_basename = 'cmd2doc'
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
162
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
163
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
164 # -- Options for LaTeX output --------------------------------------------------
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
165
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
166 # The paper size ('letter' or 'a4').
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
167 #latex_paper_size = 'letter'
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
168
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
169 # The font size ('10pt', '11pt' or '12pt').
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
170 #latex_font_size = '10pt'
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
171
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
172 # Grouping the document tree into LaTeX files. List of tuples
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
173 # (source start file, target name, title, author, documentclass [howto/manual]).
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
174 latex_documents = [
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
175 ('index', 'cmd2.tex', u'cmd2 Documentation',
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
176 u'Catherine Devlin', 'manual'),
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
177 ]
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
178
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
179 # The name of an image file (relative to this directory) to place at the top of
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
180 # the title page.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
181 #latex_logo = None
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
182
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
183 # For "manual" documents, if this is true, then toplevel headings are parts,
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
184 # not chapters.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
185 #latex_use_parts = False
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
186
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
187 # Additional stuff for the LaTeX preamble.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
188 #latex_preamble = ''
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
189
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
190 # Documents to append as an appendix to all manuals.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
191 #latex_appendices = []
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
192
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
193 # If false, no module index is generated.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
194 #latex_use_modindex = True
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
195
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
196
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
197 # Example configuration for intersphinx: refer to the Python standard library.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
198 intersphinx_mapping = {'http://docs.python.org/': None}