8
8
# The contents of this file are pickled, so don't put values in the namespace
9
9
# that aren't pickleable (module imports are okay, they're removed automatically).
11
# All configuration values have a default value; values that are commented out
12
# serve to show the default value.
11
# All configuration values have a default; values that are commented out
12
# serve to show the default.
17
# If your extensions are in another directory, add it here.
18
sys.path.append(os.path.join(os.path.dirname(__file__), "_ext"))
20
# General configuration
21
# ---------------------
17
# If extensions (or modules to document with autodoc) are in another directory,
18
# add these directories to sys.path here. If the directory is relative to the
19
# documentation root, use os.path.abspath to make it absolute, like shown here.
20
sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "_ext")))
22
# -- General configuration -----------------------------------------------------
24
# If your documentation needs a minimal Sphinx version, state it here.
23
27
# Add any Sphinx extension module names here, as strings. They can be extensions
24
28
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
25
29
extensions = ["djangodocs"]
27
31
# Add any paths that contain templates here, relative to this directory.
28
templates_path = ["_templates"]
30
34
# The suffix of source filenames.
31
35
source_suffix = '.txt'
37
# The encoding of source files.
38
#source_encoding = 'utf-8-sig'
33
40
# The master toctree document.
34
41
master_doc = 'contents'
38
45
copyright = 'Django Software Foundation and contributors'
40
# The default replacements for |version| and |release|, also used in various
41
# other places throughout the built documents.
48
# The version info for the project you're documenting, acts as replacement for
49
# |version| and |release|, also used in various other places throughout the
43
52
# The short X.Y version.
47
56
# The next version to be released
48
57
django_next_version = '1.3'
59
# The language for content autogenerated by Sphinx. Refer to documentation
60
# for a list of supported languages.
50
63
# There are two options for replacing |today|: either, you set today to some
51
64
# non-false value, then it is used:
53
66
# Else, today_fmt is used as the format for a strftime call.
54
67
today_fmt = '%B %d, %Y'
56
# List of documents that shouldn't be included in the build.
69
# List of patterns, relative to source directory, that match files and
70
# directories to ignore when looking for source files.
71
exclude_patterns = ['_build']
73
# The reST default role (used for this markup: `text`) to use for all documents.
59
76
# If true, '()' will be appended to :func: etc. cross-reference text.
60
77
add_function_parentheses = True
75
92
# Note: exclude_dirnames is new in Sphinx 0.5
76
93
exclude_dirnames = ['.svn']
78
# Options for HTML output
79
# -----------------------
81
# The style sheet to use for HTML and HTML Help pages. A file of that name
82
# must exist either in Sphinx' static/ path, or in one of the custom paths
83
# given in html_static_path.
84
html_style = 'default.css'
95
# -- Options for HTML output ---------------------------------------------------
97
# The theme to use for HTML and HTML Help pages. See the documentation for
98
# a list of builtin themes.
99
html_theme = "djangodocs"
101
# Theme options are theme-specific and customize the look and feel of a theme
102
# further. For a list of options available for each theme, see the
104
#html_theme_options = {}
106
# Add any paths that contain custom themes here, relative to this directory.
107
html_theme_path = ["_theme"]
109
# The name for this set of Sphinx documents. If None, it defaults to
110
# "<project> v<release> documentation".
113
# A shorter title for the navigation bar. Default is the same as html_title.
114
#html_short_title = None
116
# The name of an image file (relative to this directory) to place at the top
120
# The name of an image file (within the static path) to use as favicon of the
121
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
86
125
# Add any paths that contain custom static files (such as style sheets) here,
87
126
# relative to this directory. They are copied after the builtin static files,
110
149
html_additional_pages = {}
112
151
# If false, no module index is generated.
113
#html_use_modindex = True
115
# If true, the reST sources are included in the HTML build as _sources/<name>.
116
html_copy_source = True
152
#html_domain_indices = True
154
# If false, no index is generated.
155
#html_use_index = True
157
# If true, the index is split into individual pages for each letter.
158
#html_split_index = False
160
# If true, links to the reST sources are added to the pages.
161
#html_show_sourcelink = True
163
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
164
#html_show_sphinx = True
166
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
167
#html_show_copyright = True
169
# If true, an OpenSearch description file will be output, and all pages will
170
# contain a <link> tag referring to it. The value of this option must be the
171
# base URL from which the finished HTML is served.
172
#html_use_opensearch = ''
174
# This is the file name suffix for HTML files (e.g. ".xhtml").
175
#html_file_suffix = None
118
177
# Output file base name for HTML help builder.
119
178
htmlhelp_basename = 'Djangodoc'
122
# Options for LaTeX output
123
# ------------------------
180
modindex_common_prefix = ["django."]
183
# -- Options for LaTeX output --------------------------------------------------
125
185
# The paper size ('letter' or 'a4').
126
186
#latex_paper_size = 'letter'
132
192
# (source start file, target name, title, author, document class [howto/manual]).
133
193
#latex_documents = []
134
194
latex_documents = [
135
('contents', 'django.tex', 'Django Documentation', 'Django Software Foundation', 'manual'),
195
('contents', 'django.tex', u'Django Documentation',
196
u'Django Software Foundation', 'manual'),
199
# The name of an image file (relative to this directory) to place at the top of
203
# For "manual" documents, if this is true, then toplevel headings are parts,
205
#latex_use_parts = False
207
# If true, show page references after internal links.
208
#latex_show_pagerefs = False
210
# If true, show URL addresses after external links.
211
#latex_show_urls = False
138
213
# Additional stuff for the LaTeX preamble.
139
214
#latex_preamble = ''
142
217
#latex_appendices = []
144
219
# If false, no module index is generated.
145
#latex_use_modindex = True
147
# For "manual" documents, if this is true, then toplevel headings are parts,
149
# If this isn't set to True, the LaTex writer can only handle six levels of headers.
150
latex_use_parts = True
220
#latex_domain_indices = True
223
# -- Options for manual page output --------------------------------------------
225
# One entry per manual page. List of tuples
226
# (source start file, name, description, authors, manual section).
228
('contents', 'django', 'Django Documentation', ['Django Software Foundation'], 1)
232
# -- Options for Epub output ---------------------------------------------------
234
# Bibliographic Dublin Core info.
235
epub_title = u'Django'
236
epub_author = u'Django Software Foundation'
237
epub_publisher = u'Django Software Foundation'
238
epub_copyright = u'2010, Django Software Foundation'
240
# The language of the text. It defaults to the language option
241
# or en if the language is not set.
244
# The scheme of the identifier. Typical schemes are ISBN or URL.
247
# The unique identifier of the text. This can be a ISBN number
248
# or the project homepage.
249
#epub_identifier = ''
251
# A unique identification for the text.
254
# HTML files that should be inserted before the pages created by sphinx.
255
# The format is a list of tuples containing the path and title.
258
# HTML files shat should be inserted after the pages created by sphinx.
259
# The format is a list of tuples containing the path and title.
260
#epub_post_files = []
262
# A list of files that should not be packed into the epub file.
263
#epub_exclude_files = []
265
# The depth of the table of contents in toc.ncx.
268
# Allow duplicate toc entries.
added
removed
docs/conf.py
