Skip to content

HTTPS clone URL

Subversion checkout URL

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