Final changelog bump for 0.7.2-1
[debian-pyxattr.git] / doc / conf.py
1 # -*- coding: utf-8 -*-
2 #
3 # pyxattr documentation build configuration file, created by
4 # sphinx-quickstart on Sun May 13 01:05:18 2012.
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
16 # If extensions (or modules to document with autodoc) are in another directory,
17 # add these directories to sys.path here. If the directory is relative to the
18 # documentation root, use os.path.abspath to make it absolute, like shown here.
19 sys.path.insert(0, os.path.abspath('../'))
20
21 # -- General configuration -----------------------------------------------------
22
23 # If your documentation needs a minimal Sphinx version, state it here.
24 #needs_sphinx = '1.0'
25
26 # Add any Sphinx extension module names here, as strings. They can be extensions
27 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
28 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'recommonmark']
29
30 # Add any paths that contain templates here, relative to this directory.
31 templates_path = ['_templates']
32
33 # The suffix of source filenames.
34 source_suffix = ['.rst', '.md']
35
36 # The encoding of source files.
37 #source_encoding = 'utf-8-sig'
38
39 # The master toctree document.
40 master_doc = 'index'
41
42 # General information about the project.
43 project = u'pyxattr'
44 copyright = u'2002, 2003, 2006, 2008, 2012, 2013, 2014, 2015, Iustin Pop'
45
46 # The version info for the project you're documenting, acts as replacement for
47 # |version| and |release|, also used in various other places throughout the
48 # built documents.
49 #
50 # The short X.Y version.
51 version = '0.7.2'
52 # The full version, including alpha/beta/rc tags.
53 release = '0.7.2'
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 patterns, relative to source directory, that match files and
66 # directories to ignore when looking for source files.
67 exclude_patterns = ['_build', 'html']
68
69 # The reST default role (used for this markup: `text`) to use for all documents.
70 #default_role = None
71
72 default_domain = 'python'
73
74 # If true, '()' will be appended to :func: etc. cross-reference text.
75 #add_function_parentheses = True
76
77 # If true, the current module name will be prepended to all description
78 # unit titles (such as .. function::).
79 #add_module_names = True
80
81 # If true, sectionauthor and moduleauthor directives will be shown in the
82 # output. They are ignored by default.
83 #show_authors = False
84
85 # The name of the Pygments (syntax highlighting) style to use.
86 pygments_style = 'sphinx'
87
88 # A list of ignored prefixes for module index sorting.
89 #modindex_common_prefix = []
90
91 keep_warnings = True
92
93 # Note: this is still needed in Sphinx 1.8 with recommonmark 0.4.0
94 # (https://github.com/readthedocs/recommonmark/issues/119):
95 source_parsers = {
96    '.md': 'recommonmark.parser.CommonMarkParser',
97 }
98
99 # -- Options for HTML output ---------------------------------------------------
100
101 # The theme to use for HTML and HTML Help pages.  See the documentation for
102 # a list of builtin themes.
103 html_theme = 'default'
104
105 # Theme options are theme-specific and customize the look and feel of a theme
106 # further.  For a list of options available for each theme, see the
107 # documentation.
108 #html_theme_options = {}
109
110 # Add any paths that contain custom themes here, relative to this directory.
111 #html_theme_path = []
112
113 # The name for this set of Sphinx documents.  If None, it defaults to
114 # "<project> v<release> documentation".
115 #html_title = None
116
117 # A shorter title for the navigation bar.  Default is the same as html_title.
118 #html_short_title = None
119
120 # The name of an image file (relative to this directory) to place at the top
121 # of the sidebar.
122 #html_logo = None
123
124 # The name of an image file (within the static path) to use as favicon of the
125 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
126 # pixels large.
127 #html_favicon = None
128
129 # Add any paths that contain custom static files (such as style sheets) here,
130 # relative to this directory. They are copied after the builtin static files,
131 # so a file named "default.css" will overwrite the builtin "default.css".
132 #html_static_path = ['_static']
133 html_static_path = []
134
135 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
136 # using the given strftime format.
137 #html_last_updated_fmt = '%b %d, %Y'
138
139 # If true, SmartyPants will be used to convert quotes and dashes to
140 # typographically correct entities.
141 #html_use_smartypants = True
142
143 # Custom sidebar templates, maps document names to template names.
144 #html_sidebars = {}
145
146 # Additional templates that should be rendered to pages, maps page names to
147 # template names.
148 #html_additional_pages = {}
149
150 # If false, no module index is generated.
151 #html_domain_indices = True
152 html_domain_indices = False
153
154 # If false, no index is generated.
155 #html_use_index = True
156 html_use_index = False
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 html_show_sourcelink = False
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 = 'pyxattrdoc'
181
182
183 # -- Options for LaTeX output --------------------------------------------------
184
185 latex_elements = {
186 # The paper size ('letterpaper' or 'a4paper').
187 #'papersize': 'letterpaper',
188
189 # The font size ('10pt', '11pt' or '12pt').
190 #'pointsize': '10pt',
191
192 # Additional stuff for the LaTeX preamble.
193 #'preamble': '',
194 }
195
196 # Grouping the document tree into LaTeX files. List of tuples
197 # (source start file, target name, title, author, documentclass [howto/manual]).
198 latex_documents = [
199   ('index', 'pyxattr.tex', u'pyxattr Documentation',
200    u'Iustin Pop', 'manual'),
201 ]
202
203 # The name of an image file (relative to this directory) to place at the top of
204 # the title page.
205 #latex_logo = None
206
207 # For "manual" documents, if this is true, then toplevel headings are parts,
208 # not chapters.
209 #latex_use_parts = False
210
211 # If true, show page references after internal links.
212 #latex_show_pagerefs = False
213
214 # If true, show URL addresses after external links.
215 #latex_show_urls = False
216
217 # Documents to append as an appendix to all manuals.
218 #latex_appendices = []
219
220 # If false, no module index is generated.
221 #latex_domain_indices = True
222
223
224 # -- Options for manual page output --------------------------------------------
225
226 # One entry per manual page. List of tuples
227 # (source start file, name, description, authors, manual section).
228 man_pages = [
229     ('index', 'pyxattr', u'pyxattr Documentation',
230      [u'Iustin Pop'], 1)
231 ]
232
233 # If true, show URL addresses after external links.
234 #man_show_urls = False
235
236
237 # -- Options for Texinfo output ------------------------------------------------
238
239 # Grouping the document tree into Texinfo files. List of tuples
240 # (source start file, target name, title, author,
241 #  dir menu entry, description, category)
242 texinfo_documents = [
243   ('index', 'pyxattr', u'pyxattr Documentation',
244    u'Iustin Pop', 'pyxattr', 'One line description of project.',
245    'Miscellaneous'),
246 ]
247
248 # Documents to append as an appendix to all manuals.
249 #texinfo_appendices = []
250
251 # If false, no module index is generated.
252 #texinfo_domain_indices = True
253
254 # How to display URL addresses: 'footnote', 'no', or 'inline'.
255 #texinfo_show_urls = 'footnote'
256
257 autodoc_member_order = 'alphabetical'