Merge pull request #22 from blackshirt/master
[debian-id-ebook.git] / conf.py
blobe31b30adad03954aaeb3d3c8cfacbbf1134ff9a1
1 # -*- coding: utf-8 -*-
3 # Catatan Debian documentation build configuration file, created by
4 # sphinx-quickstart on Mon Dec 17 14:58:11 2012.
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
9 # autogenerated file.
11 # All configuration values have a default; values that are commented out
12 # serve to show the default.
14 import sys, os, re, glob
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('.'))
21 # -- General configuration -----------------------------------------------------
23 # If your documentation needs a minimal Sphinx version, state it here.
24 #needs_sphinx = '1.0'
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 = []
30 # Add any paths that contain templates here, relative to this directory.
31 templates_path = ['_templates']
33 # The suffix of source filenames.
34 source_suffix = '.rst'
36 # The encoding of source files.
37 #source_encoding = 'utf-8-sig'
39 # The master toctree document.
40 master_doc = 'index'
42 # General information about the project.
43 project = u'Debian GNU/Linux 7th Edition'
44 authors = 'Azkari Azikin, Tim Debian Indonesia'
45 copyright = u'2012, '+authors
47 # The version info for the project you're documenting, acts as replacement for
48 # |version| and |release|, also used in various other places throughout the
49 # built documents.
51 # The short X.Y version.
52 version = '7.0'
53 # The full version, including alpha/beta/rc tags.
54 release = '7.0~rc1'
56 # The language for content autogenerated by Sphinx. Refer to documentation
57 # for a list of supported languages.
58 #language = None
60 # There are two options for replacing |today|: either, you set today to some
61 # non-false value, then it is used:
62 #today = ''
63 # Else, today_fmt is used as the format for a strftime call.
64 #today_fmt = '%B %d, %Y'
66 # List of patterns, relative to source directory, that match files and
67 # directories to ignore when looking for source files.
68 exclude_patterns = ['_build', 'README.rst']
70 locale_dirs = ["po/"]
71 gettext_compact = True
73 # The reST default role (used for this markup: `text`) to use for all documents.
74 #default_role = None
76 # If true, '()' will be appended to :func: etc. cross-reference text.
77 #add_function_parentheses = True
79 # If true, the current module name will be prepended to all description
80 # unit titles (such as .. function::).
81 #add_module_names = True
83 # If true, sectionauthor and moduleauthor directives will be shown in the
84 # output. They are ignored by default.
85 #show_authors = False
87 # The name of the Pygments (syntax highlighting) style to use.
88 pygments_style = 'sphinx'
90 # A list of ignored prefixes for module index sorting.
91 #modindex_common_prefix = []
94 # -- Options for HTML output ---------------------------------------------------
96 # The theme to use for HTML and HTML Help pages. See the documentation for
97 # a list of builtin themes.
98 html_theme = 'solar'
100 # Theme options are theme-specific and customize the look and feel of a theme
101 # further. For a list of options available for each theme, see the
102 # documentation.
103 #html_theme_options = {}
105 # Add any paths that contain custom themes here, relative to this directory.
106 html_theme_path = ['themes']
108 # The name for this set of Sphinx documents. If None, it defaults to
109 # "<project> v<release> documentation".
110 html_title = 'Debian GNU/Linux 7th Edition'
112 # A shorter title for the navigation bar. Default is the same as html_title.
113 #html_short_title = None
115 # The name of an image file (relative to this directory) to place at the top
116 # of the sidebar.
117 #html_logo = None
119 # The name of an image file (within the static path) to use as favicon of the
120 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
121 # pixels large.
122 #html_favicon = None
124 # Add any paths that contain custom static files (such as style sheets) here,
125 # relative to this directory. They are copied after the builtin static files,
126 # so a file named "default.css" will overwrite the builtin "default.css".
127 html_static_path = ['_static']
129 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
130 # using the given strftime format.
131 html_last_updated_fmt = '%d %b %Y'
133 # If true, SmartyPants will be used to convert quotes and dashes to
134 # typographically correct entities.
135 #html_use_smartypants = True
137 # Custom sidebar templates, maps document names to template names.
138 #html_sidebars = {}
140 # Additional templates that should be rendered to pages, maps page names to
141 # template names.
142 #html_additional_pages = {}
144 # If false, no module index is generated.
145 #html_domain_indices = True
147 # If false, no index is generated.
148 #html_use_index = True
150 # If true, the index is split into individual pages for each letter.
151 #html_split_index = False
153 # If true, links to the reST sources are added to the pages.
154 html_show_sourcelink = False
156 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
157 html_show_sphinx = False
159 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
160 html_show_copyright = True
162 # If true, an OpenSearch description file will be output, and all pages will
163 # contain a <link> tag referring to it. The value of this option must be the
164 # base URL from which the finished HTML is served.
165 #html_use_opensearch = ''
167 # This is the file name suffix for HTML files (e.g. ".xhtml").
168 #html_file_suffix = None
170 # Output file base name for HTML help builder.
171 htmlhelp_basename = 'CatatanDebiandoc'
174 # -- Options for LaTeX output --------------------------------------------------
176 latex_elements = {
177 # The paper size ('letterpaper' or 'a4paper').
178 #'papersize': 'letterpaper',
180 # The font size ('10pt', '11pt' or '12pt').
181 #'pointsize': '10pt',
183 # Additional stuff for the LaTeX preamble.
184 'preamble': '\setcounter{tocdepth}{4}',
187 # Grouping the document tree into LaTeX files. List of tuples
188 # (source start file, target name, title, author, documentclass [howto/manual]).
189 latex_documents = [
190 ('index', 'Debian-GNU-Linux-7th-Edition.tex', u'Debian GNU/Linux 7th Edition',
191 u'Azkari Azikin + Tim Debian Indonesia', 'manual'),
194 # The name of an image file (relative to this directory) to place at the top of
195 # the title page.
196 #latex_logo = None
198 # For "manual" documents, if this is true, then toplevel headings are parts,
199 # not chapters.
200 #latex_use_parts = False
202 # If true, show page references after internal links.
203 latex_show_pagerefs = True
205 # If true, show URL addresses after external links.
206 latex_show_urls = 'footnote'
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).
219 man_pages = [
220 ('index', 'catatandebian', u'Debian GNU/Linux Tutorial',
221 [u'Azkari Azikin + Tim Debian Indonesia'], 1)
224 # If true, show URL addresses after external links.
225 #man_show_urls = False
228 # -- Options for Texinfo output ------------------------------------------------
230 # Grouping the document tree into Texinfo files. List of tuples
231 # (source start file, target name, title, author,
232 # dir menu entry, description, category)
233 texinfo_documents = [
234 ('index', 'CatatanDebian', u'Debian GNU/Linux Tutorial',
235 u'Azkari Azikin + Tim Debian Indonesia', 'CatatanDebian', 'Tutorial Debian GNU/Linux Wheezy.',
236 'Miscellaneous'),
239 # Documents to append as an appendix to all manuals.
240 #texinfo_appendices = []
242 # If false, no module index is generated.
243 #texinfo_domain_indices = True
245 # How to display URL addresses: 'footnote', 'no', or 'inline'.
246 #texinfo_show_urls = 'footnote'
248 # -- Options for Epub output ---------------------------------------------------
250 # Bibliographic Dublin Core info.
251 epub_title = u'Debian Install Howto'
252 epub_author = u'Tim Debian Indonesia'
253 epub_publisher = u'Tim Debian Indonesia'
254 epub_copyright = u'2012, Tim Debian Indonesia'
256 # The language of the text. It defaults to the language option
257 # or en if the language is not set.
258 #epub_language = ''
260 # The scheme of the identifier. Typical schemes are ISBN or URL.
261 #epub_scheme = ''
263 # The unique identifier of the text. This can be a ISBN number
264 # or the project homepage.
265 #epub_identifier = ''
267 # A unique identification for the text.
268 #epub_uid = ''
270 # A tuple containing the cover image and cover page html template filenames.
271 epub_cover = ('_static/epub/cover.png', 'epub-cover.html')
273 # HTML files that should be inserted before the pages created by sphinx.
274 # The format is a list of tuples containing the path and title.
275 #epub_pre_files = []
277 # HTML files shat should be inserted after the pages created by sphinx.
278 # The format is a list of tuples containing the path and title.
279 #epub_post_files = []
281 # A list of files that should not be packed into the epub file.
282 #epub_exclude_files = []
284 # The depth of the table of contents in toc.ncx.
285 #epub_tocdepth = 3
287 # Allow duplicate toc entries.
288 #epub_tocdup = True