doc/ncmpc.1: migrate to Sphinx
[ncmpc-debian.git] / doc / conf.py
1 #!/usr/bin/env python3
2 # -*- coding: utf-8 -*-
3
4 # -- General configuration ------------------------------------------------
5
6 # If your documentation needs a minimal Sphinx version, state it here.
7 #
8 # needs_sphinx = '1.0'
9
10 # Add any Sphinx extension module names here, as strings. They can be
11 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
12 # ones.
13 extensions = []
14
15 # Add any paths that contain templates here, relative to this directory.
16 templates_path = ['_templates']
17
18 # The suffix(es) of source filenames.
19 # You can specify multiple suffix as a list of string:
20 #
21 # source_suffix = ['.rst', '.md']
22 source_suffix = '.rst'
23
24 # The encoding of source files.
25 #
26 # source_encoding = 'utf-8-sig'
27
28 # The master toctree document.
29 master_doc = 'index'
30
31 # General information about the project.
32 project = 'ncmpc'
33 copyright = 'Copyright (C) 2004-2018 The Music Player Daemon Project'
34 author = 'Max Kellermann'
35
36 # The version info for the project you're documenting, acts as replacement for
37 # |version| and |release|, also used in various other places throughout the
38 # built documents.
39 #
40 # The short X.Y version.
41 version = '0.30'
42 # The full version, including alpha/beta/rc tags.
43 release = version
44
45 # The language for content autogenerated by Sphinx. Refer to documentation
46 # for a list of supported languages.
47 #
48 # This is also used if you do content translation via gettext catalogs.
49 # Usually you set "language" from the command line for these cases.
50 language = None
51
52 # There are two options for replacing |today|: either, you set today to some
53 # non-false value, then it is used:
54 #
55 # today = ''
56 #
57 # Else, today_fmt is used as the format for a strftime call.
58 #
59 # today_fmt = '%B %d, %Y'
60
61 # List of patterns, relative to source directory, that match files and
62 # directories to ignore when looking for source files.
63 # This patterns also effect to html_static_path and html_extra_path
64 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
65
66 # The reST default role (used for this markup: `text`) to use for all
67 # documents.
68 #
69 # default_role = None
70
71 # If true, '()' will be appended to :func: etc. cross-reference text.
72 #
73 # add_function_parentheses = True
74
75 # If true, the current module name will be prepended to all description
76 # unit titles (such as .. function::).
77 #
78 # add_module_names = True
79
80 # If true, sectionauthor and moduleauthor directives will be shown in the
81 # output. They are ignored by default.
82 #
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 # If true, keep warnings as "system message" paragraphs in the built documents.
92 # keep_warnings = False
93
94 # If true, `todo` and `todoList` produce output, else they produce nothing.
95 todo_include_todos = False
96
97
98 # -- Options for HTML output ----------------------------------------------
99
100 # The theme to use for HTML and HTML Help pages.  See the documentation for
101 # a list of builtin themes.
102 #
103 #html_theme = 'alabaster'
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 #
109 # html_theme_options = {}
110
111 # Add any paths that contain custom themes here, relative to this directory.
112 # html_theme_path = []
113
114 # The name for this set of Sphinx documents.
115 # "<project> v<release> documentation" by default.
116 #
117 # html_title = 'ncmpc v2.0'
118
119 # A shorter title for the navigation bar.  Default is the same as html_title.
120 #
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 #
126 # html_logo = None
127
128 # The name of an image file (relative to this directory) to use as a favicon of
129 # the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
130 # pixels large.
131 #
132 # html_favicon = None
133
134 # Add any paths that contain custom static files (such as style sheets) here,
135 # relative to this directory. They are copied after the builtin static files,
136 # so a file named "default.css" will overwrite the builtin "default.css".
137 html_static_path = ['_static']
138
139 # Add any extra paths that contain custom files (such as robots.txt or
140 # .htaccess) here, relative to this directory. These files are copied
141 # directly to the root of the documentation.
142 #
143 # html_extra_path = []
144
145 # If not None, a 'Last updated on:' timestamp is inserted at every page
146 # bottom, using the given strftime format.
147 # The empty string is equivalent to '%b %d, %Y'.
148 #
149 # html_last_updated_fmt = None
150
151 # If true, SmartyPants will be used to convert quotes and dashes to
152 # typographically correct entities.
153 #
154 # html_use_smartypants = True
155
156 # Custom sidebar templates, maps document names to template names.
157 #
158 # html_sidebars = {}
159
160 # Additional templates that should be rendered to pages, maps page names to
161 # template names.
162 #
163 # html_additional_pages = {}
164
165 # If false, no module index is generated.
166 #
167 # html_domain_indices = True
168
169 # If false, no index is generated.
170 #
171 # html_use_index = True
172
173 # If true, the index is split into individual pages for each letter.
174 #
175 # html_split_index = False
176
177 # If true, links to the reST sources are added to the pages.
178 #
179 # html_show_sourcelink = True
180
181 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
182 #
183 # html_show_sphinx = True
184
185 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
186 #
187 # html_show_copyright = True
188
189 # If true, an OpenSearch description file will be output, and all pages will
190 # contain a <link> tag referring to it.  The value of this option must be the
191 # base URL from which the finished HTML is served.
192 #
193 # html_use_opensearch = ''
194
195 # This is the file name suffix for HTML files (e.g. ".xhtml").
196 # html_file_suffix = None
197
198 # Language to be used for generating the HTML full-text search index.
199 # Sphinx supports the following languages:
200 #   'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
201 #   'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
202 #
203 # html_search_language = 'en'
204
205 # A dictionary with options for the search language support, empty by default.
206 # 'ja' uses this config value.
207 # 'zh' user can custom change `jieba` dictionary path.
208 #
209 # html_search_options = {'type': 'default'}
210
211 # The name of a javascript file (relative to the configuration directory) that
212 # implements a search results scorer. If empty, the default will be used.
213 #
214 # html_search_scorer = 'scorer.js'
215
216 # Output file base name for HTML help builder.
217 htmlhelp_basename = 'ncmpcdoc'
218
219 # -- Options for LaTeX output ---------------------------------------------
220
221 latex_elements = {
222      # The paper size ('letterpaper' or 'a4paper').
223      #
224      # 'papersize': 'letterpaper',
225
226      # The font size ('10pt', '11pt' or '12pt').
227      #
228      # 'pointsize': '10pt',
229
230      # Additional stuff for the LaTeX preamble.
231      #
232      # 'preamble': '',
233
234      # Latex figure (float) alignment
235      #
236      # 'figure_align': 'htbp',
237 }
238
239 # Grouping the document tree into LaTeX files. List of tuples
240 # (source start file, target name, title,
241 #  author, documentclass [howto, manual, or own class]).
242 latex_documents = [
243     (master_doc, 'ncmpc.tex', 'ncmpc Documentation',
244      'Max Kellermann', 'manual'),
245 ]
246
247 # The name of an image file (relative to this directory) to place at the top of
248 # the title page.
249 #
250 # latex_logo = None
251
252 # For "manual" documents, if this is true, then toplevel headings are parts,
253 # not chapters.
254 #
255 # latex_use_parts = False
256
257 # If true, show page references after internal links.
258 #
259 # latex_show_pagerefs = False
260
261 # If true, show URL addresses after external links.
262 #
263 # latex_show_urls = False
264
265 # Documents to append as an appendix to all manuals.
266 #
267 # latex_appendices = []
268
269 # It false, will not define \strong, \code,     itleref, \crossref ... but only
270 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
271 # packages.
272 #
273 # latex_keep_old_macro_names = True
274
275 # If false, no module index is generated.
276 #
277 # latex_domain_indices = True
278
279
280 # -- Options for manual page output ---------------------------------------
281
282 # One entry per manual page. List of tuples
283 # (source start file, name, description, authors, manual section).
284 man_pages = [
285     (master_doc, 'ncmpc', 'ncmpc Documentation',
286      [author], 1)
287 ]
288
289 # If true, show URL addresses after external links.
290 #
291 # man_show_urls = False
292
293
294 # -- Options for Texinfo output -------------------------------------------
295
296 # Grouping the document tree into Texinfo files. List of tuples
297 # (source start file, target name, title, author,
298 #  dir menu entry, description, category)
299 texinfo_documents = [
300     (master_doc, 'ncmpc', 'ncmpc Documentation',
301      author, 'ncmpc', 'One line description of project.',
302      'Miscellaneous'),
303 ]
304
305 # Documents to append as an appendix to all manuals.
306 #
307 # texinfo_appendices = []
308
309 # If false, no module index is generated.
310 #
311 # texinfo_domain_indices = True
312
313 # How to display URL addresses: 'footnote', 'no', or 'inline'.
314 #
315 # texinfo_show_urls = 'footnote'
316
317 # If true, do not generate a @detailmenu in the "Top" node's menu.
318 #
319 # texinfo_no_detailmenu = False