Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 224 lines (163 sloc) 7.4 kb
d3cfe7a @parente Initial IBM code drop
parente authored
1 # -*- coding: utf-8 -*-
2 #
3 # Open Cooperative Web Framework documentation build configuration file, created by
4 # sphinx-quickstart on Thu Dec 16 14:55:05 2010.
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.
19 #sys.path.insert(0, os.path.abspath('.'))
20
21 # -- General configuration -----------------------------------------------------
22
23 # If your documentation needs a minimal Sphinx version, state it here.
24 needs_sphinx = '1.0'
25
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.ifconfig', 'sphinx.ext.todo']
29 todo_include_todos = True
30
31 # Add any paths that contain templates here, relative to this directory.
32 templates_path = ['_templates']
33
34 # The suffix of source filenames.
35 source_suffix = '.rst'
36
37 # The encoding of source files.
38 #source_encoding = 'utf-8-sig'
39
40 # The master toctree document.
41 master_doc = 'index'
42
43 # General information about the project.
44 project = u'Open Cooperative Web Framework'
ce3241c @parente Remove extra period in doc copyright
parente authored
45 copyright = u'2011 The Dojo Foundation. All Rights Reserved'
d3cfe7a @parente Initial IBM code drop
parente authored
46
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
49 # built documents.
50 #
51 # The short X.Y version.
235c78a @ccotter Change next version form 0.8.3.2-SNAPSHOT to 0.8.4-SNAPSHOT
ccotter authored
52 version = '0.8.4-SNAPSHOT'
d3cfe7a @parente Initial IBM code drop
parente authored
53 # The full version, including alpha/beta/rc tags.
235c78a @ccotter Change next version form 0.8.3.2-SNAPSHOT to 0.8.4-SNAPSHOT
ccotter authored
54 release = '0.8.4-SNAPSHOT'
d3cfe7a @parente Initial IBM code drop
parente authored
55
56 # The language for content autogenerated by Sphinx. Refer to documentation
57 # for a list of supported languages.
58 #language = None
59
60 # There are two options for replacing |today|: either, you set today to some
61 # non-false value, then it is used:
62 #today = ''
63 # Else, today_fmt is used as the format for a strftime call.
64 #today_fmt = '%B %d, %Y'
65
66 # List of patterns, relative to source directory, that match files and
67 # directories to ignore when looking for source files.
68 exclude_patterns = ['_build', 'replace.rst']
69
70 # The reST default role (used for this markup: `text`) to use for all documents.
71 #default_role = None
72
73 # If true, '()' will be appended to :func: etc. cross-reference text.
74 #add_function_parentheses = True
75
76 # If true, the current module name will be prepended to all description
77 # unit titles (such as .. function::).
78 #add_module_names = True
79
80 # If true, sectionauthor and moduleauthor directives will be shown in the
81 # output. They are ignored by default.
82 #show_authors = False
83
84 # The name of the Pygments (syntax highlighting) style to use.
85 pygments_style = 'sphinx'
86
87 # A list of ignored prefixes for module index sorting.
88 #modindex_common_prefix = []
89
90
91 # -- Options for HTML output ---------------------------------------------------
92
93 # The theme to use for HTML and HTML Help pages. See the documentation for
94 # a list of builtin themes.
95 html_theme = 'nature'
96
97 # Theme options are theme-specific and customize the look and feel of a theme
98 # further. For a list of options available for each theme, see the
99 # documentation.
100 #html_theme_options = {}
101
102 # Add any paths that contain custom themes here, relative to this directory.
103 #html_theme_path = []
104
105 # The name for this set of Sphinx documents. If None, it defaults to
106 # "<project> v<release> documentation".
107 #html_title = None
108
109 # A shorter title for the navigation bar. Default is the same as html_title.
110 #html_short_title = None
111
112 # The name of an image file (relative to this directory) to place at the top
113 # of the sidebar.
114 #html_logo = None
115
116 # The name of an image file (within the static path) to use as favicon of the
117 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
118 # pixels large.
119 #html_favicon = None
120
121 # Add any paths that contain custom static files (such as style sheets) here,
122 # relative to this directory. They are copied after the builtin static files,
123 # so a file named "default.css" will overwrite the builtin "default.css".
124 html_static_path = ['_static']
125
126 # Use our own top level stylesheet for some customizations.
127 html_style = 'coweb.css'
128
129 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
130 # using the given strftime format.
131 #html_last_updated_fmt = '%b %d, %Y'
132
133 # If true, SmartyPants will be used to convert quotes and dashes to
134 # typographically correct entities.
135 #html_use_smartypants = True
136
137 # Custom sidebar templates, maps document names to template names.
138 #html_sidebars = {}
139
140 # Additional templates that should be rendered to pages, maps page names to
141 # template names.
142 #html_additional_pages = {}
143
144 # If false, no module index is generated.
71942bf @parente Don't generate Python module list in doc
parente authored
145 html_domain_indices = False
d3cfe7a @parente Initial IBM code drop
parente authored
146
147 # Primary domain for API markup
148 primary_domain = 'js'
149
150 # If false, no index is generated.
151 #html_use_index = True
152
153 # If true, the index is split into individual pages for each letter.
154 #html_split_index = False
155
156 # If true, links to the reST sources are added to the pages.
157 #html_show_sourcelink = True
158
159 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
160 #html_show_sphinx = True
161
162 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
163 #html_show_copyright = True
164
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 = ''
169
170 # This is the file name suffix for HTML files (e.g. ".xhtml").
171 #html_file_suffix = None
172
173 # Output file base name for HTML help builder.
174 htmlhelp_basename = 'OpenCooperativeWebFrameworkdoc'
175
176
177 # -- Options for LaTeX output --------------------------------------------------
178
179 # The paper size ('letter' or 'a4').
180 #latex_paper_size = 'letter'
181
182 # The font size ('10pt', '11pt' or '12pt').
183 #latex_font_size = '10pt'
184
185 # Grouping the document tree into LaTeX files. List of tuples
186 # (source start file, target name, title, author, documentclass [howto/manual]).
187 latex_documents = [
188 ('index', 'OpenCooperativeWebFramework.tex', u'Open Cooperative Web Framework Documentation',
189 u'Dojo Foundation', 'manual'),
190 ]
191
192 # The name of an image file (relative to this directory) to place at the top of
193 # the title page.
194 #latex_logo = None
195
196 # For "manual" documents, if this is true, then toplevel headings are parts,
197 # not chapters.
198 #latex_use_parts = False
199
200 # If true, show page references after internal links.
201 #latex_show_pagerefs = False
202
203 # If true, show URL addresses after external links.
204 #latex_show_urls = False
205
206 # Additional stuff for the LaTeX preamble.
207 #latex_preamble = ''
208
209 # Documents to append as an appendix to all manuals.
210 #latex_appendices = []
211
212 # If false, no module index is generated.
213 #latex_domain_indices = True
214
215
216 # -- Options for manual page output --------------------------------------------
217
218 # One entry per manual page. List of tuples
219 # (source start file, name, description, authors, manual section).
220 man_pages = [
221 ('index', 'opencooperativewebframework', u'Open Cooperative Web Framework Documentation',
222 [u'Dojo Foundation'], 1)
223 ]
Something went wrong with that request. Please try again.