blob: f108d77a0f73ec04e4558d8abe16a6384992136b [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".
Patrick Rudolpha78e66e52018-05-13 16:06:51 +020061html_static_path = ['_static']
62
63html_context = {
64 'css_files': [
65 '_static/theme_overrides.css', # override wide tables in RTD theme
66 ],
67}
Jonathan Neuschäfer5e48c752018-04-19 16:23:56 +020068
69# Output file base name for HTML help builder.
70htmlhelp_basename = 'corebootdoc'
71
72# -- Options for LaTeX output ---------------------------------------------
73
74latex_elements = {
75 # The paper size ('letterpaper' or 'a4paper').
76 #
77 # 'papersize': 'letterpaper',
78
79 # The font size ('10pt', '11pt' or '12pt').
80 #
81 # 'pointsize': '10pt',
82
83 # Additional stuff for the LaTeX preamble.
84 #
85 # 'preamble': '',
86
87 # Latex figure (float) alignment
88 #
89 # 'figure_align': 'htbp',
90}
91
92# Grouping the document tree into LaTeX files. List of tuples
93# (source start file, target name, title,
94# author, documentclass [howto, manual, or own class]).
95latex_documents = [
96 (master_doc, 'coreboot.tex', u'coreboot Documentation',
97 u'the coreboot project', 'manual'),
98]
99
100# The name of an image file (relative to this directory) to place at the top of
101# the title page.
102#
103# latex_logo = None
104
105# For "manual" documents, if this is true, then toplevel headings are parts,
106# not chapters.
107#
108# latex_use_parts = False
109
110# If true, show page references after internal links.
111#
112# latex_show_pagerefs = False
113
114# If true, show URL addresses after external links.
115#
116# latex_show_urls = False
117
118# Documents to append as an appendix to all manuals.
119#
120# latex_appendices = []
121
122# It false, will not define \strong, \code, itleref, \crossref ... but only
123# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
124# packages.
125#
126# latex_keep_old_macro_names = True
127
128# If false, no module index is generated.
129#
130# latex_domain_indices = True
131
132
133# -- Options for manual page output ---------------------------------------
134
135# One entry per manual page. List of tuples
136# (source start file, name, description, authors, manual section).
137man_pages = [
138 (master_doc, 'coreboot', u'coreboot Documentation',
139 [author], 1)
140]
141
142# If true, show URL addresses after external links.
143#
144# man_show_urls = False
145
146
147# -- Options for Texinfo output -------------------------------------------
148
149# Grouping the document tree into Texinfo files. List of tuples
150# (source start file, target name, title, author,
151# dir menu entry, description, category)
152texinfo_documents = [
153 (master_doc, 'coreboot', u'coreboot Documentation',
154 author, 'coreboot', 'One line description of project.',
155 'Miscellaneous'),
156]
157
158source_parsers = {
159 '.md': 'recommonmark.parser.CommonMarkParser',
160}
161
162# Documents to append as an appendix to all manuals.
163#
164# texinfo_appendices = []
165
166# If false, no module index is generated.
167#
168# texinfo_domain_indices = True
169
170# How to display URL addresses: 'footnote', 'no', or 'inline'.
171#
172# texinfo_show_urls = 'footnote'
173
174# If true, do not generate a @detailmenu in the "Top" node's menu.
175#
176# texinfo_no_detailmenu = False
177
178enable_auto_toc_tree = True
179
180
181def setup(app):
182 from recommonmark.transform import AutoStructify
183 app.add_config_value('recommonmark_config', {
184 'enable_auto_toc_tree': True,
185 'enable_auto_doc_ref': True,
Philipp Deppenwiese57df0882018-05-09 12:07:38 +0200186 'enable_eval_rst': True,
Jonathan Neuschäfer5e48c752018-04-19 16:23:56 +0200187 'url_resolver': lambda url: '/' + url
188 }, True)
189 app.add_transform(AutoStructify)