blob: 85e0438579e1cde66f35f6a77971a0216e704024 [file] [log] [blame]
Jonathan Neuschäfer5e48c752018-04-19 16:23:56 +02001# -*- coding: utf-8 -*-
2
3# Add any paths that contain templates here, relative to this directory.
4templates_path = ['_templates']
5
6# The suffix(es) of source filenames.
7source_suffix = ['.md']
8
9# The master toctree document.
10master_doc = 'index'
11
12# General information about the project.
13project = u'coreboot'
14copyright = u'the coreboot project'
15author = u'the coreboot project'
16
17# The version info for the project you're documenting, acts as replacement for
18# |version| and |release|, also used in various other places throughout the
19# built documents.
20#
21# The short X.Y version.
22version = u'4.7'
23# The full version, including alpha/beta/rc tags.
24release = u'4.7' # TODO: use 'git describe'
25
26# The language for content autogenerated by Sphinx. Refer to documentation
27# for a list of supported languages.
28#
29# This is also used if you do content translation via gettext catalogs.
30# Usually you set "language" from the command line for these cases.
31language = None
32
33# List of patterns, relative to source directory, that match files and
34# directories to ignore when looking for source files.
35# This patterns also effect to html_static_path and html_extra_path
36exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
37
38# The name of the Pygments (syntax highlighting) style to use.
39pygments_style = 'sphinx'
40
41# A list of ignored prefixes for module index sorting.
42# modindex_common_prefix = []
43
44# If true, keep warnings as "system message" paragraphs in the built documents.
45# keep_warnings = False
46
47# If true, `todo` and `todoList` produce output, else they produce nothing.
48todo_include_todos = False
49
50
51# -- Options for HTML output ----------------------------------------------
52
53# The theme to use for HTML and HTML Help pages. See the documentation for
54# a list of builtin themes.
55#
56html_theme = 'sphinx_rtd_theme'
57
58# Add any paths that contain custom static files (such as style sheets) here,
59# relative to this directory. They are copied after the builtin static files,
60# so a file named "default.css" will overwrite the builtin "default.css".
61#html_static_path = ['_static']
62
63# Output file base name for HTML help builder.
64htmlhelp_basename = 'corebootdoc'
65
66# -- Options for LaTeX output ---------------------------------------------
67
68latex_elements = {
69 # The paper size ('letterpaper' or 'a4paper').
70 #
71 # 'papersize': 'letterpaper',
72
73 # The font size ('10pt', '11pt' or '12pt').
74 #
75 # 'pointsize': '10pt',
76
77 # Additional stuff for the LaTeX preamble.
78 #
79 # 'preamble': '',
80
81 # Latex figure (float) alignment
82 #
83 # 'figure_align': 'htbp',
84}
85
86# Grouping the document tree into LaTeX files. List of tuples
87# (source start file, target name, title,
88# author, documentclass [howto, manual, or own class]).
89latex_documents = [
90 (master_doc, 'coreboot.tex', u'coreboot Documentation',
91 u'the coreboot project', 'manual'),
92]
93
94# The name of an image file (relative to this directory) to place at the top of
95# the title page.
96#
97# latex_logo = None
98
99# For "manual" documents, if this is true, then toplevel headings are parts,
100# not chapters.
101#
102# latex_use_parts = False
103
104# If true, show page references after internal links.
105#
106# latex_show_pagerefs = False
107
108# If true, show URL addresses after external links.
109#
110# latex_show_urls = False
111
112# Documents to append as an appendix to all manuals.
113#
114# latex_appendices = []
115
116# It false, will not define \strong, \code, itleref, \crossref ... but only
117# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
118# packages.
119#
120# latex_keep_old_macro_names = True
121
122# If false, no module index is generated.
123#
124# latex_domain_indices = True
125
126
127# -- Options for manual page output ---------------------------------------
128
129# One entry per manual page. List of tuples
130# (source start file, name, description, authors, manual section).
131man_pages = [
132 (master_doc, 'coreboot', u'coreboot Documentation',
133 [author], 1)
134]
135
136# If true, show URL addresses after external links.
137#
138# man_show_urls = False
139
140
141# -- Options for Texinfo output -------------------------------------------
142
143# Grouping the document tree into Texinfo files. List of tuples
144# (source start file, target name, title, author,
145# dir menu entry, description, category)
146texinfo_documents = [
147 (master_doc, 'coreboot', u'coreboot Documentation',
148 author, 'coreboot', 'One line description of project.',
149 'Miscellaneous'),
150]
151
152source_parsers = {
153 '.md': 'recommonmark.parser.CommonMarkParser',
154}
155
156# Documents to append as an appendix to all manuals.
157#
158# texinfo_appendices = []
159
160# If false, no module index is generated.
161#
162# texinfo_domain_indices = True
163
164# How to display URL addresses: 'footnote', 'no', or 'inline'.
165#
166# texinfo_show_urls = 'footnote'
167
168# If true, do not generate a @detailmenu in the "Top" node's menu.
169#
170# texinfo_no_detailmenu = False
171
172enable_auto_toc_tree = True
173
174
175def setup(app):
176 from recommonmark.transform import AutoStructify
177 app.add_config_value('recommonmark_config', {
178 'enable_auto_toc_tree': True,
179 'enable_auto_doc_ref': True,
Philipp Deppenwiese57df0882018-05-09 12:07:38 +0200180 'enable_eval_rst': True,
Jonathan Neuschäfer5e48c752018-04-19 16:23:56 +0200181 'url_resolver': lambda url: '/' + url
182 }, True)
183 app.add_transform(AutoStructify)