llvm.org GIT mirror llvm / 75083eb
[docs] Stub out structure for Sphinx-based docs. - Work in progress, this is just the basic structure. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@155132 91177308-0d34-0410-b5e6-96231b3b80d8 Daniel Dunbar 7 years ago
15 changed file(s) with 1059 addition(s) and 0 deletion(s). Raw diff Collapse all Expand all
3939 tools/clang
4040 # LLDB, which is tracked independently.
4141 tools/lldb
42 # Sphinx build tree, if building in-source dir.
43 docs/_build
0 # Makefile for Sphinx documentation
1 #
2
3 # You can set these variables from the command line.
4 SPHINXOPTS =
5 SPHINXBUILD = sphinx-build
6 PAPER =
7 BUILDDIR = _build
8
9 # Internal variables.
10 PAPEROPT_a4 = -D latex_paper_size=a4
11 PAPEROPT_letter = -D latex_paper_size=letter
12 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
13 # the i18n builder cannot share the environment and doctrees with the others
14 I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
15
16 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
17
18 all: html
19
20 help:
21 @echo "Please use \`make ' where is one of"
22 @echo " html to make standalone HTML files"
23 @echo " dirhtml to make HTML files named index.html in directories"
24 @echo " singlehtml to make a single large HTML file"
25 @echo " pickle to make pickle files"
26 @echo " json to make JSON files"
27 @echo " htmlhelp to make HTML files and a HTML help project"
28 @echo " qthelp to make HTML files and a qthelp project"
29 @echo " devhelp to make HTML files and a Devhelp project"
30 @echo " epub to make an epub"
31 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
32 @echo " latexpdf to make LaTeX files and run them through pdflatex"
33 @echo " text to make text files"
34 @echo " man to make manual pages"
35 @echo " texinfo to make Texinfo files"
36 @echo " info to make Texinfo files and run them through makeinfo"
37 @echo " gettext to make PO message catalogs"
38 @echo " changes to make an overview of all changed/added/deprecated items"
39 @echo " linkcheck to check all external links for integrity"
40 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
41
42 clean:
43 -rm -rf $(BUILDDIR)/*
44
45 html:
46 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
47 @echo
48 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
49
50 dirhtml:
51 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
52 @echo
53 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
54
55 singlehtml:
56 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
57 @echo
58 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
59
60 pickle:
61 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
62 @echo
63 @echo "Build finished; now you can process the pickle files."
64
65 json:
66 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
67 @echo
68 @echo "Build finished; now you can process the JSON files."
69
70 htmlhelp:
71 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
72 @echo
73 @echo "Build finished; now you can run HTML Help Workshop with the" \
74 ".hhp project file in $(BUILDDIR)/htmlhelp."
75
76 qthelp:
77 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
78 @echo
79 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
80 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
81 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/llvm.qhcp"
82 @echo "To view the help file:"
83 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/llvm.qhc"
84
85 devhelp:
86 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
87 @echo
88 @echo "Build finished."
89 @echo "To view the help file:"
90 @echo "# mkdir -p $$HOME/.local/share/devhelp/llvm"
91 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/llvm"
92 @echo "# devhelp"
93
94 epub:
95 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
96 @echo
97 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
98
99 latex:
100 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
101 @echo
102 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
103 @echo "Run \`make' in that directory to run these through (pdf)latex" \
104 "(use \`make latexpdf' here to do that automatically)."
105
106 latexpdf:
107 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
108 @echo "Running LaTeX files through pdflatex..."
109 $(MAKE) -C $(BUILDDIR)/latex all-pdf
110 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
111
112 text:
113 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
114 @echo
115 @echo "Build finished. The text files are in $(BUILDDIR)/text."
116
117 man:
118 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
119 @echo
120 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
121
122 texinfo:
123 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
124 @echo
125 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
126 @echo "Run \`make' in that directory to run these through makeinfo" \
127 "(use \`make info' here to do that automatically)."
128
129 info:
130 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
131 @echo "Running Texinfo files through makeinfo..."
132 make -C $(BUILDDIR)/texinfo info
133 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
134
135 gettext:
136 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
137 @echo
138 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
139
140 changes:
141 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
142 @echo
143 @echo "The overview file is in $(BUILDDIR)/changes."
144
145 linkcheck:
146 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
147 @echo
148 @echo "Link check complete; look for any errors in the above output " \
149 "or in $(BUILDDIR)/linkcheck/output.txt."
150
151 doctest:
152 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
153 @echo "Testing of doctests in the sources finished, look at the " \
154 "results in $(BUILDDIR)/doctest/output.txt."
0 LLVM Documentation
1 ==================
2
3 The LLVM documentation is currently written in two formats:
4
5 * Plain HTML documentation.
6
7 * reStructured Text documentation using the Sphinx documentation generator. It
8 is currently tested with Sphinx 1.1.3.
9
10 For more information, see the "Sphinx Introduction for LLVM Developers"
11 document.
0 {# This template defines the 'index.html' page which we currently only use as
1 the entry point to the HTML-based documentation, but later can use to provide
2 an entry point for a Sphinx based LLVM website.
3
4 Conceptually, this page is not supposed to be part of the documentation per
5 se (i.e., the content that would be rendered into a PDF, for example), but
6 rather provides entry points into the documentation and links to other
7 content which would only be part of the website. #}
8
9 {% extends "layout.html" %}
10 {% set title = 'lld' %}
11 {% block body %}
12

LLVM System Documentation

13
14

15 This is the front page for the Sphinx-based LLVM documentation. This is
16 currently a work in progress.
17

18
19

Documentation

20
21
22
23
24 Contents
25 for a complete overview

26
27 Search page
28 search the documentation

29
30 General Index
31 all functions, classes, terms

32
33
34
35

Source

36

LLVM is available via public SVN repository:

37 svn co
38
39 http://llvm.org/svn/llvm-project/llvm/trunk.

40
41

LLVM source can be browsed

42 via ViewVC.

43
44

LLVM is also available via a read-only git mirror:

45 git clone
46
47 http://llvm.org/git/llvm.git.

48
49 {% endblock %}
0 {# This template defines sidebar which can be used to provide common links on
1 all documentation pages. #}
2
3

Bugs

4
5

LLVM bugs should be reported to

6 Bugzilla.

0 {% extends "!layout.html" %}
1
2 {% block extrahead %}
3
7 {% endblock %}
8
9 {% block rootrellink %}
10
  • LLVM Home | 
  • 11
  • Documentation»
  • 12 {% endblock %}
    0 # -*- coding: utf-8 -*-
    1 #
    2 # LLVM documentation build configuration file.
    3 #
    4 # This file is execfile()d with the current directory set to its containing dir.
    5 #
    6 # Note that not all possible configuration values are present in this
    7 # autogenerated file.
    8 #
    9 # All configuration values have a default; values that are commented out
    10 # serve to show the default.
    11
    12 import sys, os
    13
    14 # If extensions (or modules to document with autodoc) are in another directory,
    15 # add these directories to sys.path here. If the directory is relative to the
    16 # documentation root, use os.path.abspath to make it absolute, like shown here.
    17 #sys.path.insert(0, os.path.abspath('.'))
    18
    19 # -- General configuration -----------------------------------------------------
    20
    21 # If your documentation needs a minimal Sphinx version, state it here.
    22 #needs_sphinx = '1.0'
    23
    24 # Add any Sphinx extension module names here, as strings. They can be extensions
    25 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
    26 extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.todo']
    27
    28 # Add any paths that contain templates here, relative to this directory.
    29 templates_path = ['_templates']
    30
    31 # The suffix of source filenames.
    32 source_suffix = '.rst'
    33
    34 # The encoding of source files.
    35 #source_encoding = 'utf-8-sig'
    36
    37 # The master toctree document.
    38 master_doc = 'contents'
    39
    40 # General information about the project.
    41 project = u'LLVM'
    42 copyright = u'2012, LLVM Project'
    43
    44 # The version info for the project you're documenting, acts as replacement for
    45 # |version| and |release|, also used in various other places throughout the
    46 # built documents.
    47 #
    48 # The short X.Y version.
    49 version = '3.1'
    50 # The full version, including alpha/beta/rc tags.
    51 release = '3.1'
    52
    53 # The language for content autogenerated by Sphinx. Refer to documentation
    54 # for a list of supported languages.
    55 #language = None
    56
    57 # There are two options for replacing |today|: either, you set today to some
    58 # non-false value, then it is used:
    59 #today = ''
    60 # Else, today_fmt is used as the format for a strftime call.
    61 today_fmt = '%Y-%m-%d'
    62
    63 # List of patterns, relative to source directory, that match files and
    64 # directories to ignore when looking for source files.
    65 exclude_patterns = ['_build']
    66
    67 # The reST default role (used for this markup: `text`) to use for all documents.
    68 #default_role = None
    69
    70 # If true, '()' will be appended to :func: etc. cross-reference text.
    71 #add_function_parentheses = True
    72
    73 # If true, the current module name will be prepended to all description
    74 # unit titles (such as .. function::).
    75 #add_module_names = True
    76
    77 # If true, sectionauthor and moduleauthor directives will be shown in the
    78 # output. They are ignored by default.
    79 show_authors = True
    80
    81 # The name of the Pygments (syntax highlighting) style to use.
    82 pygments_style = 'friendly'
    83
    84 # A list of ignored prefixes for module index sorting.
    85 #modindex_common_prefix = []
    86
    87
    88 # -- Options for HTML output ---------------------------------------------------
    89
    90 # The theme to use for HTML and HTML Help pages. See the documentation for
    91 # a list of builtin themes.
    92 html_theme = 'llvm-theme'
    93
    94 # Theme options are theme-specific and customize the look and feel of a theme
    95 # further. For a list of options available for each theme, see the
    96 # documentation.
    97 #html_theme_options = {}
    98
    99 # Add any paths that contain custom themes here, relative to this directory.
    100 html_theme_path = ["."]
    101
    102 # The name for this set of Sphinx documents. If None, it defaults to
    103 # " v documentation".
    104 #html_title = None
    105
    106 # A shorter title for the navigation bar. Default is the same as html_title.
    107 #html_short_title = None
    108
    109 # The name of an image file (relative to this directory) to place at the top
    110 # of the sidebar.
    111 #html_logo = None
    112
    113 # The name of an image file (within the static path) to use as favicon of the
    114 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
    115 # pixels large.
    116 #html_favicon = None
    117
    118 # Add any paths that contain custom static files (such as style sheets) here,
    119 # relative to this directory. They are copied after the builtin static files,
    120 # so a file named "default.css" will overwrite the builtin "default.css".
    121 #html_static_path = ['_static']
    122
    123 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
    124 # using the given strftime format.
    125 html_last_updated_fmt = '%Y-%m-%d'
    126
    127 # If true, SmartyPants will be used to convert quotes and dashes to
    128 # typographically correct entities.
    129 #html_use_smartypants = True
    130
    131 # Custom sidebar templates, maps document names to template names.
    132 html_sidebars = {'index': 'indexsidebar.html'}
    133
    134 # Additional templates that should be rendered to pages, maps page names to
    135 # template names.
    136 html_additional_pages = {'index': 'index.html'}
    137
    138 # If false, no module index is generated.
    139 #html_domain_indices = True
    140
    141 # If false, no index is generated.
    142 #html_use_index = True
    143
    144 # If true, the index is split into individual pages for each letter.
    145 #html_split_index = False
    146
    147 # If true, links to the reST sources are added to the pages.
    148 html_show_sourcelink = True
    149
    150 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
    151 #html_show_sphinx = True
    152
    153 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
    154 #html_show_copyright = True
    155
    156 # If true, an OpenSearch description file will be output, and all pages will
    157 # contain a tag referring to it. The value of this option must be the
    158 # base URL from which the finished HTML is served.
    159 #html_use_opensearch = ''
    160
    161 # This is the file name suffix for HTML files (e.g. ".xhtml").
    162 #html_file_suffix = None
    163
    164 # Output file base name for HTML help builder.
    165 htmlhelp_basename = 'LLVMdoc'
    166
    167
    168 # -- Options for LaTeX output --------------------------------------------------
    169
    170 latex_elements = {
    171 # The paper size ('letterpaper' or 'a4paper').
    172 #'papersize': 'letterpaper',
    173
    174 # The font size ('10pt', '11pt' or '12pt').
    175 #'pointsize': '10pt',
    176
    177 # Additional stuff for the LaTeX preamble.
    178 #'preamble': '',
    179 }
    180
    181 # Grouping the document tree into LaTeX files. List of tuples
    182 # (source start file, target name, title, author, documentclass [howto/manual]).
    183 latex_documents = [
    184 ('contents', 'LLVM.tex', u'LLVM Documentation',
    185 u'LLVM project', 'manual'),
    186 ]
    187
    188 # The name of an image file (relative to this directory) to place at the top of
    189 # the title page.
    190 #latex_logo = None
    191
    192 # For "manual" documents, if this is true, then toplevel headings are parts,
    193 # not chapters.
    194 #latex_use_parts = False
    195
    196 # If true, show page references after internal links.
    197 #latex_show_pagerefs = False
    198
    199 # If true, show URL addresses after external links.
    200 #latex_show_urls = False
    201
    202 # Documents to append as an appendix to all manuals.
    203 #latex_appendices = []
    204
    205 # If false, no module index is generated.
    206 #latex_domain_indices = True
    207
    208
    209 # -- Options for manual page output --------------------------------------------
    210
    211 # One entry per manual page. List of tuples
    212 # (source start file, name, description, authors, manual section).
    213 man_pages = [
    214 ('contents', 'LLVM', u'LLVM Documentation',
    215 [u'LLVM project'], 1)
    216 ]
    217
    218 # If true, show URL addresses after external links.
    219 #man_show_urls = False
    220
    221
    222 # -- Options for Texinfo output ------------------------------------------------
    223
    224 # Grouping the document tree into Texinfo files. List of tuples
    225 # (source start file, target name, title, author,
    226 # dir menu entry, description, category)
    227 texinfo_documents = [
    228 ('contents', 'LLVM', u'LLVM Documentation',
    229 u'LLVM project', 'LLVM', 'One line description of project.',
    230 'Miscellaneous'),
    231 ]
    232
    233 # Documents to append as an appendix to all manuals.
    234 #texinfo_appendices = []
    235
    236 # If false, no module index is generated.
    237 #texinfo_domain_indices = True
    238
    239 # How to display URL addresses: 'footnote', 'no', or 'inline'.
    240 #texinfo_show_urls = 'footnote'
    241
    242
    243 # FIXME: Define intersphinx configration.
    244 intersphinx_mapping = {}
    0 .. _contents:
    1
    2 Contents
    3 ========
    4
    5 .. toctree::
    6 :maxdepth: 2
    7
    8 Indices and tables
    9 ==================
    10
    11 * :ref:`genindex`
    12 * :ref:`search`
    0 {#
    1 sphinxdoc/layout.html
    2 ~~~~~~~~~~~~~~~~~~~~~
    3
    4 Sphinx layout template for the sphinxdoc theme.
    5
    6 :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
    7 :license: BSD, see LICENSE for details.
    8 #}
    9 {% extends "basic/layout.html" %}
    10
    11 {% block relbar1 %}
    12
    13
    14
    15 alt="LLVM Logo" width="250" height="88"/>
    16
    17 {{ super() }}
    18 {% endblock %}
    19
    20 {# put the sidebar before the body #}
    21 {% block sidebar1 %}{{ sidebar() }}{% endblock %}
    22 {% block sidebar2 %}{% endblock %}
    0 /*
    1 * sphinxdoc.css_t
    2 * ~~~~~~~~~~~~~~~
    3 *
    4 * Sphinx stylesheet -- sphinxdoc theme. Originally created by
    5 * Armin Ronacher for Werkzeug.
    6 *
    7 * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
    8 * :license: BSD, see LICENSE for details.
    9 *
    10 */
    11
    12 @import url("basic.css");
    13
    14 /* -- page layout ----------------------------------------------------------- */
    15
    16 body {
    17 font-family: 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva',
    18 'Verdana', sans-serif;
    19 font-size: 14px;
    20 letter-spacing: -0.01em;
    21 line-height: 150%;
    22 text-align: center;
    23 background-color: #BFD1D4;
    24 color: black;
    25 padding: 0;
    26 border: 1px solid #aaa;
    27
    28 margin: 0px 80px 0px 80px;
    29 min-width: 740px;
    30 }
    31
    32 div.logo {
    33 background-color: white;
    34 text-align: left;
    35 padding: 10px 10px 15px 15px;
    36 }
    37
    38 div.document {
    39 background-color: white;
    40 text-align: left;
    41 background-image: url(contents.png);
    42 background-repeat: repeat-x;
    43 }
    44
    45 div.bodywrapper {
    46 margin: 0 240px 0 0;
    47 border-right: 1px solid #ccc;
    48 }
    49
    50 div.body {
    51 margin: 0;
    52 padding: 0.5em 20px 20px 20px;
    53 }
    54
    55 div.related {
    56 font-size: 1em;
    57 }
    58
    59 div.related ul {
    60 background-image: url(navigation.png);
    61 height: 2em;
    62 border-top: 1px solid #ddd;
    63 border-bottom: 1px solid #ddd;
    64 }
    65
    66 div.related ul li {
    67 margin: 0;
    68 padding: 0;
    69 height: 2em;
    70 float: left;
    71 }
    72
    73 div.related ul li.right {
    74 float: right;
    75 margin-right: 5px;
    76 }
    77
    78 div.related ul li a {
    79 margin: 0;
    80 padding: 0 5px 0 5px;
    81 line-height: 1.75em;
    82 color: #EE9816;
    83 }
    84
    85 div.related ul li a:hover {
    86 color: #3CA8E7;
    87 }
    88
    89 div.sphinxsidebarwrapper {
    90 padding: 0;
    91 }
    92
    93 div.sphinxsidebar {
    94 margin: 0;
    95 padding: 0.5em 15px 15px 0;
    96 width: 210px;
    97 float: right;
    98 font-size: 1em;
    99 text-align: left;
    100 }
    101
    102 div.sphinxsidebar h3, div.sphinxsidebar h4 {
    103 margin: 1em 0 0.5em 0;
    104 font-size: 1em;
    105 padding: 0.1em 0 0.1em 0.5em;
    106 color: white;
    107 border: 1px solid #86989B;
    108 background-color: #AFC1C4;
    109 }
    110
    111 div.sphinxsidebar h3 a {
    112 color: white;
    113 }
    114
    115 div.sphinxsidebar ul {
    116 padding-left: 1.5em;
    117 margin-top: 7px;
    118 padding: 0;
    119 line-height: 130%;
    120 }
    121
    122 div.sphinxsidebar ul ul {
    123 margin-left: 20px;
    124 }
    125
    126 div.footer {
    127 background-color: #E3EFF1;
    128 color: #86989B;
    129 padding: 3px 8px 3px 0;
    130 clear: both;
    131 font-size: 0.8em;
    132 text-align: right;
    133 }
    134
    135 div.footer a {
    136 color: #86989B;
    137 text-decoration: underline;
    138 }
    139
    140 /* -- body styles ----------------------------------------------------------- */
    141
    142 p {
    143 margin: 0.8em 0 0.5em 0;
    144 }
    145
    146 a {
    147 color: #CA7900;
    148 text-decoration: none;
    149 }
    150
    151 a:hover {
    152 color: #2491CF;
    153 }
    154
    155 div.body a {
    156 text-decoration: underline;
    157 }
    158
    159 h1 {
    160 margin: 0;
    161 padding: 0.7em 0 0.3em 0;
    162 font-size: 1.5em;
    163 color: #11557C;
    164 }
    165
    166 h2 {
    167 margin: 1.3em 0 0.2em 0;
    168 font-size: 1.35em;
    169 padding: 0;
    170 }
    171
    172 h3 {
    173 margin: 1em 0 -0.3em 0;
    174 font-size: 1.2em;
    175 }
    176
    177 div.body h1 a, div.body h2 a, div.body h3 a, div.body h4 a, div.body h5 a, div.body h6 a {
    178 color: black!important;
    179 }
    180
    181 h1 a.anchor, h2 a.anchor, h3 a.anchor, h4 a.anchor, h5 a.anchor, h6 a.anchor {
    182 display: none;
    183 margin: 0 0 0 0.3em;
    184 padding: 0 0.2em 0 0.2em;
    185 color: #aaa!important;
    186 }
    187
    188 h1:hover a.anchor, h2:hover a.anchor, h3:hover a.anchor, h4:hover a.anchor,
    189 h5:hover a.anchor, h6:hover a.anchor {
    190 display: inline;
    191 }
    192
    193 h1 a.anchor:hover, h2 a.anchor:hover, h3 a.anchor:hover, h4 a.anchor:hover,
    194 h5 a.anchor:hover, h6 a.anchor:hover {
    195 color: #777;
    196 background-color: #eee;
    197 }
    198
    199 a.headerlink {
    200 color: #c60f0f!important;
    201 font-size: 1em;
    202 margin-left: 6px;
    203 padding: 0 4px 0 4px;
    204 text-decoration: none!important;
    205 }
    206
    207 a.headerlink:hover {
    208 background-color: #ccc;
    209 color: white!important;
    210 }
    211
    212 cite, code, tt {
    213 font-family: 'Consolas', 'Deja Vu Sans Mono',
    214 'Bitstream Vera Sans Mono', monospace;
    215 font-size: 0.95em;
    216 letter-spacing: 0.01em;
    217 }
    218
    219 tt {
    220 background-color: #f2f2f2;
    221 border-bottom: 1px solid #ddd;
    222 color: #333;
    223 }
    224
    225 tt.descname, tt.descclassname, tt.xref {
    226 border: 0;
    227 }
    228
    229 hr {
    230 border: 1px solid #abc;
    231 margin: 2em;
    232 }
    233
    234 a tt {
    235 border: 0;
    236 color: #CA7900;
    237 }
    238
    239 a tt:hover {
    240 color: #2491CF;
    241 }
    242
    243 pre {
    244 font-family: 'Consolas', 'Deja Vu Sans Mono',
    245 'Bitstream Vera Sans Mono', monospace;
    246 font-size: 0.95em;
    247 letter-spacing: 0.015em;
    248 line-height: 120%;
    249 padding: 0.5em;
    250 border: 1px solid #ccc;
    251 background-color: #f8f8f8;
    252 }
    253
    254 pre a {
    255 color: inherit;
    256 text-decoration: underline;
    257 }
    258
    259 td.linenos pre {
    260 padding: 0.5em 0;
    261 }
    262
    263 div.quotebar {
    264 background-color: #f8f8f8;
    265 max-width: 250px;
    266 float: right;
    267 padding: 2px 7px;
    268 border: 1px solid #ccc;
    269 }
    270
    271 div.topic {
    272 background-color: #f8f8f8;
    273 }
    274
    275 table {
    276 border-collapse: collapse;
    277 margin: 0 -0.5em 0 -0.5em;
    278 }
    279
    280 table td, table th {
    281 padding: 0.2em 0.5em 0.2em 0.5em;
    282 }
    283
    284 div.admonition, div.warning {
    285 font-size: 0.9em;
    286 margin: 1em 0 1em 0;
    287 border: 1px solid #86989B;
    288 background-color: #f7f7f7;
    289 padding: 0;
    290 }
    291
    292 div.admonition p, div.warning p {
    293 margin: 0.5em 1em 0.5em 1em;
    294 padding: 0;
    295 }
    296
    297 div.admonition pre, div.warning pre {
    298 margin: 0.4em 1em 0.4em 1em;
    299 }
    300
    301 div.admonition p.admonition-title,
    302 div.warning p.admonition-title {
    303 margin: 0;
    304 padding: 0.1em 0 0.1em 0.5em;
    305 color: white;
    306 border-bottom: 1px solid #86989B;
    307 font-weight: bold;
    308 background-color: #AFC1C4;
    309 }
    310
    311 div.warning {
    312 border: 1px solid #940000;
    313 }
    314
    315 div.warning p.admonition-title {
    316 background-color: #CF0000;
    317 border-bottom-color: #940000;
    318 }
    319
    320 div.admonition ul, div.admonition ol,
    321 div.warning ul, div.warning ol {
    322 margin: 0.1em 0.5em 0.5em 3em;
    323 padding: 0;
    324 }
    325
    326 div.versioninfo {
    327 margin: 1em 0 0 0;
    328 border: 1px solid #ccc;
    329 background-color: #DDEAF0;
    330 padding: 8px;
    331 line-height: 1.3em;
    332 font-size: 0.9em;
    333 }
    334
    335 .viewcode-back {
    336 font-family: 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva',
    337 'Verdana', sans-serif;
    338 }
    339
    340 div.viewcode-block:target {
    341 background-color: #f4debf;
    342 border-top: 1px solid #ac9;
    343 border-bottom: 1px solid #ac9;
    344 }
    0 [theme]
    1 inherit = basic
    2 stylesheet = llvm.css
    3 pygments_style = friendly
    0 @ECHO OFF
    1
    2 REM Command file for Sphinx documentation
    3
    4 if "%SPHINXBUILD%" == "" (
    5 set SPHINXBUILD=sphinx-build
    6 )
    7 set BUILDDIR=_build
    8 set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
    9 set I18NSPHINXOPTS=%SPHINXOPTS% .
    10 if NOT "%PAPER%" == "" (
    11 set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
    12 set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
    13 )
    14
    15 if "%1" == "" goto help
    16
    17 if "%1" == "help" (
    18 :help
    19 echo.Please use `make ^` where ^ is one of
    20 echo. html to make standalone HTML files
    21 echo. dirhtml to make HTML files named index.html in directories
    22 echo. singlehtml to make a single large HTML file
    23 echo. pickle to make pickle files
    24 echo. json to make JSON files
    25 echo. htmlhelp to make HTML files and a HTML help project
    26 echo. qthelp to make HTML files and a qthelp project
    27 echo. devhelp to make HTML files and a Devhelp project
    28 echo. epub to make an epub
    29 echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
    30 echo. text to make text files
    31 echo. man to make manual pages
    32 echo. texinfo to make Texinfo files
    33 echo. gettext to make PO message catalogs
    34 echo. changes to make an overview over all changed/added/deprecated items
    35 echo. linkcheck to check all external links for integrity
    36 echo. doctest to run all doctests embedded in the documentation if enabled
    37 goto end
    38 )
    39
    40 if "%1" == "clean" (
    41 for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
    42 del /q /s %BUILDDIR%\*
    43 goto end
    44 )
    45
    46 if "%1" == "html" (
    47 %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
    48 if errorlevel 1 exit /b 1
    49 echo.
    50 echo.Build finished. The HTML pages are in %BUILDDIR%/html.
    51 goto end
    52 )
    53
    54 if "%1" == "dirhtml" (
    55 %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
    56 if errorlevel 1 exit /b 1
    57 echo.
    58 echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
    59 goto end
    60 )
    61
    62 if "%1" == "singlehtml" (
    63 %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
    64 if errorlevel 1 exit /b 1
    65 echo.
    66 echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
    67 goto end
    68 )
    69
    70 if "%1" == "pickle" (
    71 %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
    72 if errorlevel 1 exit /b 1
    73 echo.
    74 echo.Build finished; now you can process the pickle files.
    75 goto end
    76 )
    77
    78 if "%1" == "json" (
    79 %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
    80 if errorlevel 1 exit /b 1
    81 echo.
    82 echo.Build finished; now you can process the JSON files.
    83 goto end
    84 )
    85
    86 if "%1" == "htmlhelp" (
    87 %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
    88 if errorlevel 1 exit /b 1
    89 echo.
    90 echo.Build finished; now you can run HTML Help Workshop with the ^
    91 .hhp project file in %BUILDDIR%/htmlhelp.
    92 goto end
    93 )
    94
    95 if "%1" == "qthelp" (
    96 %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
    97 if errorlevel 1 exit /b 1
    98 echo.
    99 echo.Build finished; now you can run "qcollectiongenerator" with the ^
    100 .qhcp project file in %BUILDDIR%/qthelp, like this:
    101 echo.^> qcollectiongenerator %BUILDDIR%\qthelp\llvm.qhcp
    102 echo.To view the help file:
    103 echo.^> assistant -collectionFile %BUILDDIR%\qthelp\llvm.ghc
    104 goto end
    105 )
    106
    107 if "%1" == "devhelp" (
    108 %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
    109 if errorlevel 1 exit /b 1
    110 echo.
    111 echo.Build finished.
    112 goto end
    113 )
    114
    115 if "%1" == "epub" (
    116 %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
    117 if errorlevel 1 exit /b 1
    118 echo.
    119 echo.Build finished. The epub file is in %BUILDDIR%/epub.
    120 goto end
    121 )
    122
    123 if "%1" == "latex" (
    124 %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
    125 if errorlevel 1 exit /b 1
    126 echo.
    127 echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
    128 goto end
    129 )
    130
    131 if "%1" == "text" (
    132 %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
    133 if errorlevel 1 exit /b 1
    134 echo.
    135 echo.Build finished. The text files are in %BUILDDIR%/text.
    136 goto end
    137 )
    138
    139 if "%1" == "man" (
    140 %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
    141 if errorlevel 1 exit /b 1
    142 echo.
    143 echo.Build finished. The manual pages are in %BUILDDIR%/man.
    144 goto end
    145 )
    146
    147 if "%1" == "texinfo" (
    148 %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
    149 if errorlevel 1 exit /b 1
    150 echo.
    151 echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
    152 goto end
    153 )
    154
    155 if "%1" == "gettext" (
    156 %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
    157 if errorlevel 1 exit /b 1
    158 echo.
    159 echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
    160 goto end
    161 )
    162
    163 if "%1" == "changes" (
    164 %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
    165 if errorlevel 1 exit /b 1
    166 echo.
    167 echo.The overview file is in %BUILDDIR%/changes.
    168 goto end
    169 )
    170
    171 if "%1" == "linkcheck" (
    172 %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
    173 if errorlevel 1 exit /b 1
    174 echo.
    175 echo.Link check complete; look for any errors in the above output ^
    176 or in %BUILDDIR%/linkcheck/output.txt.
    177 goto end
    178 )
    179
    180 if "%1" == "doctest" (
    181 %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
    182 if errorlevel 1 exit /b 1
    183 echo.
    184 echo.Testing of doctests in the sources finished, look at the ^
    185 results in %BUILDDIR%/doctest/output.txt.
    186 goto end
    187 )
    188
    189 :end