llvm-project

1
# -*- coding: utf-8 -*-
2
#
3
# Extra Clang Tools documentation build configuration file, created by
4
# sphinx-quickstart on Wed Feb 13 10:00:18 2013.
5
#
6
# This file is execfile()d with the current directory set to its containing dir.
7
#
8
# Note that not all possible configuration values are present in this
9
# autogenerated file.
10
#
11
# All configuration values have a default; values that are commented out
12
# serve to show the default.
13

14
import sys, os
15
from datetime import date
16

17
# If extensions (or modules to document with autodoc) are in another directory,
18
# add these directories to sys.path here. If the directory is relative to the
19
# documentation root, use os.path.abspath to make it absolute, like shown here.
20
# sys.path.insert(0, os.path.abspath('.'))
21

22
# -- General configuration -----------------------------------------------------
23

24
# If your documentation needs a minimal Sphinx version, state it here.
25
# needs_sphinx = '1.0'
26

27
# Add any Sphinx extension module names here, as strings. They can be extensions
28
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
29
extensions = ["sphinx.ext.todo", "sphinx.ext.mathjax"]
30

31
# Add any paths that contain templates here, relative to this directory.
32
templates_path = ["_templates"]
33

34
# The suffix of source filenames.
35
source_suffix = ".rst"
36

37
# The encoding of source files.
38
# source_encoding = 'utf-8-sig'
39

40
# The master toctree document.
41
master_doc = "index"
42

43
# General information about the project.
44
project = "Extra Clang Tools"
45
copyright = "2007-%d, The Clang Team" % date.today().year
46

47
# The language for content autogenerated by Sphinx. Refer to documentation
48
# for a list of supported languages.
49
# language = None
50

51
# There are two options for replacing |today|: either, you set today to some
52
# non-false value, then it is used:
53
# today = ''
54
# Else, today_fmt is used as the format for a strftime call.
55
# today_fmt = '%B %d, %Y'
56

57
# List of patterns, relative to source directory, that match files and
58
# directories to ignore when looking for source files.
59
exclude_patterns = ["_build"]
60

61
# The reST default role (used for this markup: `text`) to use for all documents.
62
# default_role = None
63

64
# If true, '()' will be appended to :func: etc. cross-reference text.
65
# add_function_parentheses = True
66

67
# If true, the current module name will be prepended to all description
68
# unit titles (such as .. function::).
69
# add_module_names = True
70

71
# If true, sectionauthor and moduleauthor directives will be shown in the
72
# output. They are ignored by default.
73
# show_authors = False
74

75
# The name of the Pygments (syntax highlighting) style to use.
76
pygments_style = "friendly"
77

78
# A list of ignored prefixes for module index sorting.
79
# modindex_common_prefix = []
80

81
in_progress_title = "(In-Progress) " if tags.has("PreRelease") else ""
82

83
rst_epilog = f"""
84
.. |ReleaseNotesTitle| replace:: {in_progress_title} Release Notes
85
"""
86

87
# -- Options for HTML output ---------------------------------------------------
88

89
# The theme to use for HTML and HTML Help pages.  See the documentation for
90
# a list of builtin themes.
91
html_theme = "haiku"
92

93
# Theme options are theme-specific and customize the look and feel of a theme
94
# further.  For a list of options available for each theme, see the
95
# documentation.
96
# html_theme_options = {}
97

98
# Add any paths that contain custom themes here, relative to this directory.
99
# html_theme_path = []
100

101
# The name for this set of Sphinx documents.  If None, it defaults to
102
# "<project> v<release> documentation".
103
# html_title = None
104

105
# A shorter title for the navigation bar.  Default is the same as html_title.
106
# html_short_title = None
107

108
# The name of an image file (relative to this directory) to place at the top
109
# of the sidebar.
110
# html_logo = None
111

112
# The name of an image file (within the static path) to use as favicon of the
113
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
114
# pixels large.
115
# html_favicon = None
116

117
# Add any paths that contain custom static files (such as style sheets) here,
118
# relative to this directory. They are copied after the builtin static files,
119
# so a file named "default.css" will overwrite the builtin "default.css".
120
html_static_path = ["_static"]
121

122
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
123
# using the given strftime format.
124
# html_last_updated_fmt = '%b %d, %Y'
125

126
# If true, SmartyPants will be used to convert quotes and dashes to
127
# typographically correct entities.
128
# html_use_smartypants = True
129

130
# Custom sidebar templates, maps document names to template names.
131
# html_sidebars = {}
132

133
# Additional templates that should be rendered to pages, maps page names to
134
# template names.
135
# html_additional_pages = {}
136

137
# If false, no module index is generated.
138
# html_domain_indices = True
139

140
# If false, no index is generated.
141
# html_use_index = True
142

143
# If true, the index is split into individual pages for each letter.
144
# html_split_index = False
145

146
# If true, links to the reST sources are added to the pages.
147
# html_show_sourcelink = True
148

149
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
150
# html_show_sphinx = True
151

152
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
153
# html_show_copyright = True
154

155
# If true, an OpenSearch description file will be output, and all pages will
156
# contain a <link> tag referring to it.  The value of this option must be the
157
# base URL from which the finished HTML is served.
158
# html_use_opensearch = ''
159

160
# This is the file name suffix for HTML files (e.g. ".xhtml").
161
# html_file_suffix = None
162

163
# Output file base name for HTML help builder.
164
htmlhelp_basename = "ExtraClangToolsdoc"
165

166

167
# -- Options for LaTeX output --------------------------------------------------
168

169
latex_elements = {
170
    # The paper size ('letterpaper' or 'a4paper').
171
    #'papersize': 'letterpaper',
172
    # The font size ('10pt', '11pt' or '12pt').
173
    #'pointsize': '10pt',
174
    # Additional stuff for the LaTeX preamble.
175
    #'preamble': '',
176
}
177

178
# Grouping the document tree into LaTeX files. List of tuples
179
# (source start file, target name, title, author, documentclass [howto/manual]).
180
latex_documents = [
181
    (
182
        "index",
183
        "ExtraClangTools.tex",
184
        "Extra Clang Tools Documentation",
185
        "The Clang Team",
186
        "manual",
187
    ),
188
]
189

190
# The name of an image file (relative to this directory) to place at the top of
191
# the title page.
192
# latex_logo = None
193

194
# For "manual" documents, if this is true, then toplevel headings are parts,
195
# not chapters.
196
# latex_use_parts = False
197

198
# If true, show page references after internal links.
199
# latex_show_pagerefs = False
200

201
# If true, show URL addresses after external links.
202
# latex_show_urls = False
203

204
# Documents to append as an appendix to all manuals.
205
# latex_appendices = []
206

207
# If false, no module index is generated.
208
# latex_domain_indices = True
209

210

211
# -- Options for manual page output --------------------------------------------
212

213
# One entry per manual page. List of tuples
214
# (source start file, name, description, authors, manual section).
215
man_pages = [
216
    (
217
        "index",
218
        "extraclangtools",
219
        "Extra Clang Tools Documentation",
220
        ["The Clang Team"],
221
        1,
222
    )
223
]
224

225
# If true, show URL addresses after external links.
226
# man_show_urls = False
227

228

229
# -- Options for Texinfo output ------------------------------------------------
230

231
# Grouping the document tree into Texinfo files. List of tuples
232
# (source start file, target name, title, author,
233
#  dir menu entry, description, category)
234
texinfo_documents = [
235
    (
236
        "index",
237
        "ExtraClangTools",
238
        "Extra Clang Tools Documentation",
239
        "The Clang Team",
240
        "ExtraClangTools",
241
        "One line description of project.",
242
        "Miscellaneous",
243
    ),
244
]
245

246
# Documents to append as an appendix to all manuals.
247
# texinfo_appendices = []
248

249
# If false, no module index is generated.
250
# texinfo_domain_indices = True
251

252
# How to display URL addresses: 'footnote', 'no', or 'inline'.
253
# texinfo_show_urls = 'footnote'
254