[RISCV] Add addu.w and slliu.w test that uses getelementptr with zero extended indices.
[lldb.git] / lldb / docs / conf.py
1 # -*- coding: utf-8 -*-
2 #
3 # LLDB documentation build configuration file, created by
4 # sphinx-quickstart on Sun Dec  9 20:01:55 2012.
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 from __future__ import print_function
14
15 import sys, os, re
16 from datetime import date
17
18 # If extensions (or modules to document with autodoc) are in another directory,
19 # add these directories to sys.path here. If the directory is relative to the
20 # documentation root, use os.path.abspath to make it absolute, like shown here.
21
22 # Add the current directory that contains the mock _lldb native module which
23 # is imported by the `lldb` module.
24 sys.path.insert(0, os.path.abspath("."))
25 # Add the build directory that contains the `lldb` module. LLDB_SWIG_MODULE is
26 # set by CMake.
27 sys.path.insert(0, os.getenv("LLDB_SWIG_MODULE"))
28
29 # Put the generated Python API documentation in the 'python_api' folder. This
30 # also defines the URL these files will have in the generated website.
31 automodapi_toctreedirnm = 'python_api'
32
33 # -- General configuration -----------------------------------------------------
34
35 # If your documentation needs a minimal Sphinx version, state it here.
36 #needs_sphinx = '1.0'
37
38 # Add any Sphinx extension module names here, as strings. They can be extensions
39 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
40 extensions = ['sphinx.ext.todo', 'sphinx.ext.mathjax', 'sphinx.ext.intersphinx',
41               'sphinx_automodapi.automodapi']
42
43 # Add any paths that contain templates here, relative to this directory.
44 templates_path = ['_templates']
45
46 # The suffix of source filenames.
47 source_suffix = {
48     '.rst': 'restructuredtext',
49 }
50
51 try:
52   import recommonmark
53 except ImportError:
54   # manpages do not use any .md sources
55   if not tags.has('builder-man'):
56     raise
57 else:
58   import sphinx
59   if sphinx.version_info >= (3, 0):
60     # This requires 0.5 or later.
61     extensions.append('recommonmark')
62   else:
63     source_parsers = {'.md': 'recommonmark.parser.CommonMarkParser'}
64   source_suffix['.md'] = 'markdown'
65
66 # The encoding of source files.
67 #source_encoding = 'utf-8-sig'
68
69 # The master toctree document.
70 master_doc = 'index'
71
72 # General information about the project.
73 project = u'LLDB'
74 copyright = u'2007-%d, The LLDB Team' % date.today().year
75
76 # The version info for the project you're documenting, acts as replacement for
77 # |version| and |release|, also used in various other places throughout the
78 # built documents. These are currently set to zero because we don't use them.
79 # Should somebody consider in the future to change them, they need to be updated
80 # everytime a new release comes out.
81 #
82 # The short version.
83 #version = '0'
84 # The full version, including alpha/beta/rc tags.
85 #release = '0'
86
87 # The language for content autogenerated by Sphinx. Refer to documentation
88 # for a list of supported languages.
89 #language = None
90
91 # There are two options for replacing |today|: either, you set today to some
92 # non-false value, then it is used:
93 #today = ''
94 # Else, today_fmt is used as the format for a strftime call.
95 #today_fmt = '%B %d, %Y'
96
97 # List of patterns, relative to source directory, that match files and
98 # directories to ignore when looking for source files.
99 exclude_patterns = ['_build', 'analyzer']
100
101 # Use the recommended 'any' rule so that referencing SB API classes is possible
102 # by just writing `SBData`.
103 default_role = 'any'
104
105 # If true, '()' will be appended to :func: etc. cross-reference text.
106 #add_function_parentheses = True
107
108 # If true, the current module name will be prepended to all description
109 # unit titles (such as .. function::).
110 #add_module_names = True
111
112 # If true, sectionauthor and moduleauthor directives will be shown in the
113 # output. They are ignored by default.
114 #show_authors = False
115
116 # The name of the Pygments (syntax highlighting) style to use.
117 pygments_style = 'friendly'
118
119 # A list of ignored prefixes for module index sorting.
120 #modindex_common_prefix = []
121
122
123 # -- Options for HTML output ---------------------------------------------------
124
125 # The theme to use for HTML and HTML Help pages.  See the documentation for
126 # a list of builtin themes.
127 html_theme = 'alabaster'
128
129 # Theme options are theme-specific and customize the look and feel of a theme
130 # further.  For a list of options available for each theme, see the
131 # documentation.
132 html_theme_options = {
133     'font_size': '11pt'
134 }
135
136 # Add any paths that contain custom themes here, relative to this directory.
137 #html_theme_path = []
138
139 # The name for this set of Sphinx documents.  If None, it defaults to
140 # "<project> v<release> documentation".
141 html_title = 'The LLDB Debugger'
142
143 # A shorter title for the navigation bar.  Default is the same as html_title.
144 #html_short_title = None
145
146 # The name of an image file (relative to this directory) to place at the top
147 # of the sidebar.
148 #html_logo = None
149
150 # The name of an image file (within the static path) to use as favicon of the
151 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
152 # pixels large.
153 #html_favicon = None
154
155 # Add any paths that contain custom static files (such as style sheets) here,
156 # relative to this directory. They are copied after the builtin static files,
157 # so a file named "default.css" will overwrite the builtin "default.css".
158 html_static_path = ['_static']
159
160 html_context = {
161     'css_files': [
162         '_static/lldb.css'
163         ],
164     }
165
166 html_extra_path = ['.htaccess']
167
168 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
169 # using the given strftime format.
170 html_last_updated_fmt = '%b %d, %Y'
171
172 # If true, SmartyPants will be used to convert quotes and dashes to
173 # typographically correct entities.
174 #html_use_smartypants = True
175
176 # Custom sidebar templates, maps document names to template names.
177 #html_sidebars = {}
178
179 # Additional templates that should be rendered to pages, maps page names to
180 # template names.
181 #html_additional_pages = {}
182
183 # If false, no module index is generated.
184 #html_domain_indices = True
185
186 # If false, no index is generated.
187 #html_use_index = True
188
189 # If true, the index is split into individual pages for each letter.
190 #html_split_index = False
191
192 # If true, links to the reST sources are added to the pages.
193 #html_show_sourcelink = True
194
195 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
196 #html_show_sphinx = True
197
198 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
199 #html_show_copyright = True
200
201 # If true, an OpenSearch description file will be output, and all pages will
202 # contain a <link> tag referring to it.  The value of this option must be the
203 # base URL from which the finished HTML is served.
204 #html_use_opensearch = ''
205
206 # This is the file name suffix for HTML files (e.g. ".xhtml").
207 #html_file_suffix = None
208
209 # Output file base name for HTML help builder.
210 htmlhelp_basename = 'LLDBdoc'
211
212 # If true, the reST sources are included in the HTML build as
213 # _sources/name. The default is True.
214 html_copy_source = False
215
216 # -- Options for LaTeX output --------------------------------------------------
217
218 latex_elements = {
219 # The paper size ('letterpaper' or 'a4paper').
220 #'papersize': 'letterpaper',
221
222 # The font size ('10pt', '11pt' or '12pt').
223 #'pointsize': '10pt',
224
225 # Additional stuff for the LaTeX preamble.
226 #'preamble': '',
227 }
228
229 # Grouping the document tree into LaTeX files. List of tuples
230 # (source start file, target name, title, author, documentclass [howto/manual]).
231 latex_documents = [
232   ('index', 'LLDB.tex', u'LLDB Documentation',
233    u'The LLDB Team', 'manual'),
234 ]
235
236 # The name of an image file (relative to this directory) to place at the top of
237 # the title page.
238 #latex_logo = None
239
240 # For "manual" documents, if this is true, then toplevel headings are parts,
241 # not chapters.
242 #latex_use_parts = False
243
244 # If true, show page references after internal links.
245 #latex_show_pagerefs = False
246
247 # If true, show URL addresses after external links.
248 #latex_show_urls = False
249
250 # Documents to append as an appendix to all manuals.
251 #latex_appendices = []
252
253 # If false, no module index is generated.
254 #latex_domain_indices = True
255
256
257 # -- Options for manual page output --------------------------------------------
258
259 # One entry per manual page. List of tuples
260 # (source start file, name, description, authors, manual section).
261 man_pages = [('man/lldb', 'lldb', u'LLDB Documentation', [u'LLVM project'], 1),
262              ('man/lldb-server', 'lldb-server', u'LLDB Documentation', [u'LLVM project'], 1),
263              ]
264
265 # If true, show URL addresses after external links.
266 #man_show_urls = False
267
268 def process_md(name):
269     file_subpath = os.path.join(command_guide_subpath, name)
270     with open(os.path.join(command_guide_path, name)) as f:
271         title = f.readline().rstrip('\n')
272
273         m = re.match(r'^# (\S+) - (.+)$', title)
274         if m is None:
275             print("error: invalid title in %r "
276                   "(expected '# <name> - <description>')" % file_subpath,
277                   file=sys.stderr)
278         else:
279             man_pages.append((file_subpath.replace('.md',''), m.group(1),
280                               m.group(2), man_page_authors, 1))
281
282 # -- Options for Texinfo output ------------------------------------------------
283
284 # Grouping the document tree into Texinfo files. List of tuples
285 # (source start file, target name, title, author,
286 #  dir menu entry, description, category)
287 texinfo_documents = [
288   ('index', 'LLDB', u'LLDB Documentation',
289    u'The LLDB Team', 'LLDB', 'One line description of project.',
290    'Miscellaneous'),
291 ]
292
293 # Documents to append as an appendix to all manuals.
294 #texinfo_appendices = []
295
296 # If false, no module index is generated.
297 #texinfo_domain_indices = True
298
299 # How to display URL addresses: 'footnote', 'no', or 'inline'.
300 #texinfo_show_urls = 'footnote'
301
302 empty_attr_summary = re.compile(r'\.\. rubric:: Attributes Summary\s*\.\. autosummary::\s*\.\. rubric::')
303 empty_attr_documentation = re.compile(r'\.\. rubric:: Attributes Documentation\s*\.\. rubric::')
304
305 def cleanup_source(app, docname, source):
306     """ Cleans up source files generated by automodapi. """
307     # Don't cleanup anything beside automodapi-generated sources.
308     if not automodapi_toctreedirnm in docname:
309       return
310     processed = source[0]
311
312     # Don't show the list of inheritance info as there is no inheritance in the
313     # SBI API. This avoids all the repeated text on all doc pages that a
314     # class inherits from 'object'.
315
316     processed = processed.replace(":show-inheritance:", "")
317     # Remove the SWIG generated 'thisown' attribute. It just bloats the generated
318     # documentation and users shouldn't fiddle with the value anyway.
319     processed = re.sub(r'~SB[a-zA-Z]+\.thisown', "", processed)
320     processed = processed.replace("  .. autoattribute:: thisown", "")
321
322     # After removing 'thisown', many objects don't have any attributes left.
323     # Remove all now empty attribute summary/documentation sections with
324     # some rather ugly regex.
325     processed = empty_attr_summary.sub('.. rubric::', processed)
326     processed = empty_attr_documentation.sub('.. rubric::', processed)
327
328     # Replace the original source with the processed one (source is a single
329     # element list).
330     source[0] = processed
331
332 def setup(app):
333     app.connect('source-read', cleanup_source)