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