Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 244 lines (178 sloc) 7.958 kb
70e6222 @mcdonc begin project
mcdonc authored
1 # -*- coding: utf-8 -*-
2 #
3 # Pyramid Cookbook documentation build configuration file, created by
4 # sphinx-quickstart on Thu Nov 11 23:40:28 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
1069e65 moved all tutorials from pyramid-tutorials to the cookbook.
Carlos de la Guardia authored
16 from docutils import nodes
17 from docutils import utils
18
70e6222 @mcdonc begin project
mcdonc authored
19 # If extensions (or modules to document with autodoc) are in another directory,
20 # add these directories to sys.path here. If the directory is relative to the
21 # documentation root, use os.path.abspath to make it absolute, like shown here.
22 sys.path.append(os.path.abspath('_themes'))
23
24 # -- General configuration -----------------------------------------------------
25
26 # If your documentation needs a minimal Sphinx version, state it here.
27 #needs_sphinx = '1.0'
28
29 # Add any Sphinx extension module names here, as strings. They can be extensions
30 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
31 extensions = [
32 'sphinx.ext.intersphinx'
33 ]
34
91b62bc @mcdonc use correct url to newest docs, exclude _themes/README.rst
mcdonc authored
35 intersphinx_mapping = {'http://docs.pylonsproject.org/projects/pyramid/en/latest/': None}
70e6222 @mcdonc begin project
mcdonc authored
36
37 # Add any paths that contain templates here, relative to this directory.
38 templates_path = ['_templates']
39
40 # The suffix of source filenames.
41 source_suffix = '.rst'
42
43 # The encoding of source files.
44 #source_encoding = 'utf-8-sig'
45
46 # The master toctree document.
47 master_doc = 'index'
48
49 # General information about the project.
50 project = u'Pyramid Cookbook'
8cdca09 @blaflamme Updated docs conf
blaflamme authored
51 copyright = u'2011, Pylons Project Contributors'
70e6222 @mcdonc begin project
mcdonc authored
52
53 # The version info for the project you're documenting, acts as replacement for
54 # |version| and |release|, also used in various other places throughout the
55 # built documents.
56 #
57 # The short X.Y version.
58 version = '0.1'
59 # The full version, including alpha/beta/rc tags.
60 release = '0.1'
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.
91b62bc @mcdonc use correct url to newest docs, exclude _themes/README.rst
mcdonc authored
74 exclude_patterns = ['_build', 'README.rst', 'unfinished', 'links.rst',
75 '_themes/README.rst']
70e6222 @mcdonc begin project
mcdonc authored
76
77 # The reST default role (used for this markup: `text`) to use for all documents.
78 #default_role = None
79
80 # If true, '()' will be appended to :func: etc. cross-reference text.
81 #add_function_parentheses = True
82
83 # If true, the current module name will be prepended to all description
84 # unit titles (such as .. function::).
85 #add_module_names = True
86
87 # If true, sectionauthor and moduleauthor directives will be shown in the
88 # output. They are ignored by default.
e2476b0 @mikeorr Config adjustments.
mikeorr authored
89 show_authors = True
70e6222 @mcdonc begin project
mcdonc authored
90
91 # The name of the Pygments (syntax highlighting) style to use.
92 pygments_style = 'sphinx'
93
94 # A list of ignored prefixes for module index sorting.
95 #modindex_common_prefix = []
96
97
98 # -- Options for HTML output ---------------------------------------------------
99
100 # Add and use Pylons theme
101 sys.path.append(os.path.abspath('_themes'))
102 html_theme_path = ['_themes']
103 html_theme = 'pyramid'
104
105 # The theme to use for HTML and HTML Help pages. See the documentation for
106 # a list of builtin themes.
107 #html_theme = 'pylons'
108
109 # Theme options are theme-specific and customize the look and feel of a theme
110 # further. For a list of options available for each theme, see the
111 # documentation.
112 #html_theme_options = {}
113
114 # Add any paths that contain custom themes here, relative to this directory.
115 #html_theme_path = ['_themes']
116
117 # The name for this set of Sphinx documents. If None, it defaults to
118 # "<project> v<release> documentation".
119 html_title = 'The Pyramid Cookbook v%s' % release
120
121 # A shorter title for the navigation bar. Default is the same as html_title.
122 #html_short_title = None
123
124 # The name of an image file (relative to this directory) to place at the top
125 # of the sidebar.
126 #html_logo = None
127
128 # The name of an image file (within the static path) to use as favicon of the
129 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
130 # pixels large.
131 #html_favicon = None
132
133 # Add any paths that contain custom static files (such as style sheets) here,
134 # relative to this directory. They are copied after the builtin static files,
135 # so a file named "default.css" will overwrite the builtin "default.css".
136 html_static_path = ['_static']
137
138 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
139 # using the given strftime format.
140 html_last_updated_fmt = '%b %d, %Y'
141
142 # If true, SmartyPants will be used to convert quotes and dashes to
143 # typographically correct entities.
144 #html_use_smartypants = True
145
146 # Custom sidebar templates, maps document names to template names.
147 #html_sidebars = {}
148
149 # Additional templates that should be rendered to pages, maps page names to
150 # template names.
151 #html_additional_pages = {}
152
153 # If false, no module index is generated.
e2476b0 @mikeorr Config adjustments.
mikeorr authored
154 html_domain_indices = False
70e6222 @mcdonc begin project
mcdonc authored
155
156 # If false, no index is generated.
157 #html_use_index = True
158
159 # If true, the index is split into individual pages for each letter.
160 #html_split_index = False
161
162 # If true, links to the reST sources are added to the pages.
163 #html_show_sourcelink = True
164
165 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
166 #html_show_sphinx = True
167
168 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
169 #html_show_copyright = True
170
171 # If true, an OpenSearch description file will be output, and all pages will
172 # contain a <link> tag referring to it. The value of this option must be the
173 # base URL from which the finished HTML is served.
174 #html_use_opensearch = ''
175
176 # This is the file name suffix for HTML files (e.g. ".xhtml").
177 #html_file_suffix = None
178
179 # Output file base name for HTML help builder.
180 htmlhelp_basename = 'pyramidcookbook'
181
182
183 # -- Options for LaTeX output --------------------------------------------------
184
185 # The paper size ('letter' or 'a4').
186 #latex_paper_size = 'letter'
187
188 # The font size ('10pt', '11pt' or '12pt').
189 #latex_font_size = '10pt'
190
191 # Grouping the document tree into LaTeX files. List of tuples
192 # (source start file, target name, title, author, documentclass [howto/manual]).
193 latex_documents = [
194 ('index', 'pyramidcookbook.tex', u'Pyramid Cookbook',
195 u'Pylons Project Contributors', 'manual'),
196 ]
197
198 # The name of an image file (relative to this directory) to place at the top of
199 # the title page.
200 #latex_logo = None
201
202 # For "manual" documents, if this is true, then toplevel headings are parts,
203 # not chapters.
204 #latex_use_parts = False
205
206 # If true, show page references after internal links.
207 #latex_show_pagerefs = False
208
209 # If true, show URL addresses after external links.
210 #latex_show_urls = False
211
212 # Additional stuff for the LaTeX preamble.
213 #latex_preamble = ''
214
215 # Documents to append as an appendix to all manuals.
216 #latex_appendices = []
217
218 # If false, no module index is generated.
219 #latex_domain_indices = True
220
221
222 # -- Options for manual page output --------------------------------------------
223
224 # One entry per manual page. List of tuples
225 # (source start file, name, description, authors, manual section).
226 man_pages = [
227 ('index', 'pyramidcookbook', u'Pyramid Cookbook',
228 [u'Pylons Project Contributors'], 1)
229 ]
230
1069e65 moved all tutorials from pyramid-tutorials to the cookbook.
Carlos de la Guardia authored
231 def app_role(role, rawtext, text, lineno, inliner, options={}, content=[]):
232 """custom role for :app: marker, does nothing in particular except allow
233 :app:`Pyramid` to work (for later search and replace)."""
234 if 'class' in options:
235 assert 'classes' not in options
236 options['classes'] = options['class']
237 del options['class']
238 return [nodes.inline(rawtext, utils.unescape(text), **options)], []
239
70e6222 @mcdonc begin project
mcdonc authored
240
1069e65 moved all tutorials from pyramid-tutorials to the cookbook.
Carlos de la Guardia authored
241 def setup(app):
242 app.add_role('app', app_role)
70e6222 @mcdonc begin project
mcdonc authored
243
Something went wrong with that request. Please try again.