1 # -*- coding: utf-8 -*-
3 # django-tables2 documentation build configuration file, created by
4 # sphinx-quickstart on Wed Jan 5 13:04:34 2011.
6 # This file is execfile()d with the current directory set to its containing dir.
8 # Note that not all possible configuration values are present in this
11 # All configuration values have a default; values that are commented out
12 # serve to show the default.
14 # If extensions (or modules to document with autodoc) are in another directory,
15 # add these directories to sys.path here. If the directory is relative to the
16 # documentation root, use os.path.abspath to make it absolute, like shown here.
19 os.environ["DJANGO_SETTINGS_MODULE"] = "example.settings"
21 sys.path.insert(0, os.path.join(os.path.abspath('.'), os.pardir))
23 import django_tables2 as tables
27 # -- General configuration -----------------------------------------------------
29 # If your documentation needs a minimal Sphinx version, state it here.
32 # Add any Sphinx extension module names here, as strings. They can be extensions
33 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
34 extensions = ['sphinx.ext.autodoc']
36 # Add any paths that contain templates here, relative to this directory.
37 templates_path = ['_templates']
39 # The suffix of source filenames.
40 source_suffix = '.rst'
42 # The encoding of source files.
43 #source_encoding = 'utf-8-sig'
45 # The master toctree document.
48 # General information about the project.
49 project = u'django-tables2'
52 # The version info for the project you're documenting, acts as replacement for
53 # |version| and |release|, also used in various other places throughout the
56 # The short X.Y version.
58 # The full version, including alpha/beta/rc tags.
61 # The language for content autogenerated by Sphinx. Refer to documentation
62 # for a list of supported languages.
65 # There are two options for replacing |today|: either, you set today to some
66 # non-false value, then it is used:
68 # Else, today_fmt is used as the format for a strftime call.
69 #today_fmt = '%B %d, %Y'
71 # List of patterns, relative to source directory, that match files and
72 # directories to ignore when looking for source files.
73 exclude_patterns = ['_build']
75 # The reST default role (used for this markup: `text`) to use for all documents.
78 # If true, '()' will be appended to :func: etc. cross-reference text.
79 #add_function_parentheses = True
81 # If true, the current module name will be prepended to all description
82 # unit titles (such as .. function::).
83 #add_module_names = True
85 # If true, sectionauthor and moduleauthor directives will be shown in the
86 # output. They are ignored by default.
89 # The name of the Pygments (syntax highlighting) style to use.
90 pygments_style = 'sphinx'
92 # A list of ignored prefixes for module index sorting.
93 #modindex_common_prefix = []
96 # -- Options for HTML output ---------------------------------------------------
98 # The theme to use for HTML and HTML Help pages. See the documentation for
99 # a list of builtin themes.
100 html_theme = 'default'
102 # Theme options are theme-specific and customize the look and feel of a theme
103 # further. For a list of options available for each theme, see the
105 #html_theme_options = {}
107 # Add any paths that contain custom themes here, relative to this directory.
108 #html_theme_path = []
110 # The name for this set of Sphinx documents. If None, it defaults to
111 # "<project> v<release> documentation".
114 # A shorter title for the navigation bar. Default is the same as html_title.
115 #html_short_title = None
117 # The name of an image file (relative to this directory) to place at the top
121 # The name of an image file (within the static path) to use as favicon of the
122 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
126 # Add any paths that contain custom static files (such as style sheets) here,
127 # relative to this directory. They are copied after the builtin static files,
128 # so a file named "default.css" will overwrite the builtin "default.css".
129 html_static_path = ['_static']
131 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
132 # using the given strftime format.
133 #html_last_updated_fmt = '%b %d, %Y'
135 # If true, SmartyPants will be used to convert quotes and dashes to
136 # typographically correct entities.
137 #html_use_smartypants = True
139 # Custom sidebar templates, maps document names to template names.
142 # Additional templates that should be rendered to pages, maps page names to
144 #html_additional_pages = {}
146 # If false, no module index is generated.
147 #html_domain_indices = True
149 # If false, no index is generated.
150 #html_use_index = True
152 # If true, the index is split into individual pages for each letter.
153 #html_split_index = False
155 # If true, links to the reST sources are added to the pages.
156 #html_show_sourcelink = True
158 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
159 #html_show_sphinx = True
161 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
162 html_show_copyright = False
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 = ''
169 # This is the file name suffix for HTML files (e.g. ".xhtml").
170 #html_file_suffix = None
172 # Output file base name for HTML help builder.
173 htmlhelp_basename = 'django-tables2doc'
176 # -- Options for LaTeX output --------------------------------------------------
178 # The paper size ('letter' or 'a4').
179 #latex_paper_size = 'letter'
181 # The font size ('10pt', '11pt' or '12pt').
182 #latex_font_size = '10pt'
184 # Grouping the document tree into LaTeX files. List of tuples
185 # (source start file, target name, title, author, documentclass [howto/manual]).
187 ('index', 'django-tables2.tex', u'django-tables2 Documentation',
191 # The name of an image file (relative to this directory) to place at the top of
195 # For "manual" documents, if this is true, then toplevel headings are parts,
197 #latex_use_parts = False
199 # If true, show page references after internal links.
200 #latex_show_pagerefs = False
202 # If true, show URL addresses after external links.
203 #latex_show_urls = False
205 # Additional stuff for the LaTeX preamble.
208 # Documents to append as an appendix to all manuals.
209 #latex_appendices = []
211 # If false, no module index is generated.
212 #latex_domain_indices = True
215 # -- Options for manual page output --------------------------------------------
217 # One entry per manual page. List of tuples
218 # (source start file, name, description, authors, manual section).
220 ('index', 'django-tables2', u'django-tables2 Documentation',