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