From 75083ebc09a3dd47099e3912ac090dbc907f3eaf Mon Sep 17 00:00:00 2001 From: Daniel Dunbar Date: Thu, 19 Apr 2012 16:31:19 +0000 Subject: [PATCH] [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 --- .gitignore | 2 + docs/Makefile.sphinx | 155 ++++++++++++ docs/README.txt | 12 + docs/_templates/index.html | 50 ++++ docs/_templates/indexsidebar.html | 7 + docs/_templates/layout.html | 13 + docs/conf.py | 245 ++++++++++++++++++ docs/contents.rst | 13 + docs/llvm-theme/layout.html | 23 ++ docs/llvm-theme/static/contents.png | Bin 0 -> 202 bytes docs/llvm-theme/static/llvm.css | 345 ++++++++++++++++++++++++++ docs/llvm-theme/static/logo.png | Bin 0 -> 9864 bytes docs/llvm-theme/static/navigation.png | Bin 0 -> 218 bytes docs/llvm-theme/theme.conf | 4 + docs/make.bat | 190 ++++++++++++++ 15 files changed, 1059 insertions(+) create mode 100644 docs/Makefile.sphinx create mode 100644 docs/README.txt create mode 100644 docs/_templates/index.html create mode 100644 docs/_templates/indexsidebar.html create mode 100644 docs/_templates/layout.html create mode 100644 docs/conf.py create mode 100644 docs/contents.rst create mode 100644 docs/llvm-theme/layout.html create mode 100644 docs/llvm-theme/static/contents.png create mode 100644 docs/llvm-theme/static/llvm.css create mode 100644 docs/llvm-theme/static/logo.png create mode 100644 docs/llvm-theme/static/navigation.png create mode 100644 docs/llvm-theme/theme.conf create mode 100644 docs/make.bat diff --git a/.gitignore b/.gitignore index b3d030e5178..cdbcbb94e9d 100644 --- a/.gitignore +++ b/.gitignore @@ -40,3 +40,5 @@ projects/* tools/clang # LLDB, which is tracked independently. tools/lldb +# Sphinx build tree, if building in-source dir. +docs/_build diff --git a/docs/Makefile.sphinx b/docs/Makefile.sphinx new file mode 100644 index 00000000000..21f66488b2b --- /dev/null +++ b/docs/Makefile.sphinx @@ -0,0 +1,155 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +all: html + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/llvm.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/llvm.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/llvm" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/llvm" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." diff --git a/docs/README.txt b/docs/README.txt new file mode 100644 index 00000000000..2fbbf987405 --- /dev/null +++ b/docs/README.txt @@ -0,0 +1,12 @@ +LLVM Documentation +================== + +The LLVM documentation is currently written in two formats: + + * Plain HTML documentation. + + * reStructured Text documentation using the Sphinx documentation generator. It + is currently tested with Sphinx 1.1.3. + + For more information, see the "Sphinx Introduction for LLVM Developers" + document. diff --git a/docs/_templates/index.html b/docs/_templates/index.html new file mode 100644 index 00000000000..efd2a157269 --- /dev/null +++ b/docs/_templates/index.html @@ -0,0 +1,50 @@ +{# This template defines the 'index.html' page which we currently only use as + the entry point to the HTML-based documentation, but later can use to provide + an entry point for a Sphinx based LLVM website. + + Conceptually, this page is not supposed to be part of the documentation per + se (i.e., the content that would be rendered into a PDF, for example), but + rather provides entry points into the documentation and links to other + content which would only be part of the website. #} + +{% extends "layout.html" %} +{% set title = 'lld' %} +{% block body %} +

LLVM System Documentation

+ +

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

+ +

Documentation

+ + + +
+

+ Contents
+ for a complete overview

+

+ Search page
+ search the documentation

+

+ General Index
+ all functions, classes, terms

+
+ +

Source

+

LLVM is available via public SVN repository: + svn co + + http://llvm.org/svn/llvm-project/llvm/trunk.

+ +

LLVM source can be browsed + via ViewVC.

+ +

LLVM is also available via a read-only git mirror: + git clone + + http://llvm.org/git/llvm.git.

+ +{% endblock %} diff --git a/docs/_templates/indexsidebar.html b/docs/_templates/indexsidebar.html new file mode 100644 index 00000000000..416174279ce --- /dev/null +++ b/docs/_templates/indexsidebar.html @@ -0,0 +1,7 @@ +{# This template defines sidebar which can be used to provide common links on + all documentation pages. #} + +

Bugs

+ +

LLVM bugs should be reported to + Bugzilla.

diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html new file mode 100644 index 00000000000..49994881200 --- /dev/null +++ b/docs/_templates/layout.html @@ -0,0 +1,13 @@ +{% extends "!layout.html" %} + +{% block extrahead %} + +{% endblock %} + +{% block rootrellink %} +
  • LLVM Home | 
    • +
  • Documentation»
    • +{% endblock %} diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000000..e44dfc0de65 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,245 @@ +# -*- coding: utf-8 -*- +# +# LLVM documentation build configuration file. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.todo'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'contents' + +# General information about the project. +project = u'LLVM' +copyright = u'2012, LLVM Project' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '3.1' +# The full version, including alpha/beta/rc tags. +release = '3.1' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +today_fmt = '%Y-%m-%d' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +show_authors = True + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'friendly' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'llvm-theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +html_theme_path = ["."] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +#html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +html_last_updated_fmt = '%Y-%m-%d' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +html_sidebars = {'index': 'indexsidebar.html'} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +html_additional_pages = {'index': 'index.html'} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'LLVMdoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('contents', 'LLVM.tex', u'LLVM Documentation', + u'LLVM project', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('contents', 'LLVM', u'LLVM Documentation', + [u'LLVM project'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('contents', 'LLVM', u'LLVM Documentation', + u'LLVM project', 'LLVM', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + + +# FIXME: Define intersphinx configration. +intersphinx_mapping = {} diff --git a/docs/contents.rst b/docs/contents.rst new file mode 100644 index 00000000000..095e5240c7c --- /dev/null +++ b/docs/contents.rst @@ -0,0 +1,13 @@ +.. _contents: + +Contents +======== + +.. toctree:: + :maxdepth: 2 + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` diff --git a/docs/llvm-theme/layout.html b/docs/llvm-theme/layout.html new file mode 100644 index 00000000000..746c2f56c82 --- /dev/null +++ b/docs/llvm-theme/layout.html @@ -0,0 +1,23 @@ +{# + sphinxdoc/layout.html + ~~~~~~~~~~~~~~~~~~~~~ + + Sphinx layout template for the sphinxdoc theme. + + :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS. + :license: BSD, see LICENSE for details. +#} +{% extends "basic/layout.html" %} + +{% block relbar1 %} + +{{ super() }} +{% endblock %} + +{# put the sidebar before the body #} +{% block sidebar1 %}{{ sidebar() }}{% endblock %} +{% block sidebar2 %}{% endblock %} diff --git a/docs/llvm-theme/static/contents.png b/docs/llvm-theme/static/contents.png new file mode 100644 index 0000000000000000000000000000000000000000..7fb82154a1748d507925865d3fbf7508d62483e5 GIT binary patch literal 202 zcmeAS@N?(olHy`uVBq!ia0vp^j6kfx!3HGlw@oMq2^0spJ29*~C-V}>;VkfoEM{Qf z76xHPhFNnYfP(BLp1!W^HyC+E#mt?nx10eANtU=qlsM<-=BDPAFgO>bCYGe8D3oWG zWGJ|M`UZqI@`(c#nR~i8hHzY8+H1+jpulh_>fir3VfEN66+Lr739Q`5pWRz06>Sig9Kks4{%Sw0^VLi(+L0&(f>6FAU*Rd z03gU)3JWVJSlBt+Ia%1*6H5vU6Wcr5nOXiY1pxPzEM;>QKy4GyHGzs)55OS-jEZ5w)BuzhU@$~R<_`Q!12Dv{ z)p@RHt5FYWz?Mp@=V>A56b;aZ`|bd%u1-%#H6e*ji@|RA$uM1jzQ-dChdF>1W$R`P z0CM9n!P?%uxleqqo|s^d0e#m0e)0$AgVe}q_kDk|!d?IXww-;a-{}|{aQ(Sq{B7Rz zzg<9C=pp91JVct+qX;wtxyLK&H}?N*BbxWCWqEmjZ*NJePe|KvMBV4zyhp!F{q4t- zFVE}4-B#xgc>uF+fH>6SR?pb2OcDNMJp50iwS!pk*Cxb|SAtp6K1rh%4H}GHMKp&P zk@Tn=<|5K?p?K>4Z!;ezJDYSbkbIkLK&=%Ygjd}6Qe9)ndud8k4d`?%zP6VLqy_?t<_I{<*52sypVNCW>M8~}*q2GG87M>*GG0qSW56&cK)~9iXc3ZN|Czo=wfQrzJ<78o zTy{5AdjLF?;1C?TA<0S@gi(YBSqvO@TJR%Dw*(YgBsuYL7=|LLbR3%mlTw5Vv8n{Y zHLv3*&QKk();R7VfI09rq+OgTF`!_orAs;*^OqQ+g~`ZpM`3Z(QCe z_PoQX3Ja8#SU%xF#;&8Uuq=H)80iOkh3fvJgHJFXts|{Osu;knRjY(-3%@g-taF1x z3lQysXNPhVA~qxxl+cjTkXw={CB`Rb{jvhj0T208v4@g0p;Y=eMeCQRzOP2iOraVQ zbYu%?vFHq_USYz09OP)>!pxK{zdlLU6{^gj&4|s|Dv=%2m1VF>;F2W_ub5cZ!*V9l z5z`I@?`7@v?y>CQ?U7t-BV-u~I21lA?@%d?SV`gRqwcfr!W&TJ&kpb8@g(`o8q8cLd-ss;^+#v3zk1R+T( zi6RM)hC!vQytsU$98vW~byOv`Oi$UTT1=HidAAIHF1bRrJWJtJ8Bf`~jJq_n+`QCI zg}=~O^DP`kvsb29Ubs*(w@!bzeSjFz7^lIVj>HTO zyeyAXm_>?3y+P?F(TpE;!byq4KiwdI>@amMkyVT{V5VbrD`( zn~2*V+mega>`p!ZY#FCBm1J9r zsf)Q~xMc>%$Hw!=7t+`=c$pTN4>Jxk7Be=R47A*}=s=~QW>d-fJ*{HR3sAdluokCg zk%p?4Zi84=R@JwKwyL(0FC{H<333(L3+BDGSD;}~Srbm}{u0b;HOL0!V`y%KZQj&h z-FuPHk>Jzn6aB^uiyXTAxq?88z}M-wBLf{p3E(m>; zy3aC8Ib&Ab9NWCbDd;9FGF&=vls<)zJ_B!HeW+tk%K6SgciVI3E-RxUqvyPIwdR8T z!tx??EoY21hdNu6#c8T{NO((ef0`dLCyCK|v(i^ySU$kK@sNzcm?2KRYO%Jd$gTXr z@DiKvp3gC7mv5JcV}p4^Q-6%3t7)idRKC|PTR(VH*pKYP3#k3xnNXoiy)?8Y+zO3es>j##n9QWDw2o8)QPwW%g@0IzDEmF zu!aYQk-ff1l)<6F>LL6w_F)>h(@ZIBZqsYRPMadnBFQ2f8Rks#oHgI2*l765>8*HH zI9gd-`3LCDG{@#OvNR-rNaJ(T(^RwD{^;C%J--Rv$=X5O^}VN1d~G=y^35;U@&@n>=E zY#!wOEJbwtEk7yCeznUW%dBT`Wn-ng65BBIa&<5T#mD_}5Gp5;O#qpnm>-zAj#iom z*T47MMm8}JCczF{H~gxE*8GkD5-L7Y(V|+Ufvq<;RX6)H9zMdET#-#Xem>SPvigf7 z^D^h-9IXd!J04UNBCYjjBk43WW)1Se3b|#la)u)L+VCl*mC7Ka5lmGdNL|2Da*%~{%Or%H6P@4XgslL zg<^Nvit4;QBl;0}$lcC8p>y5rd|kh~kFMUVo?gSHZ*$^&!tqz-FG1|85MtM=yF5j+y zD{wBjEW92%&#(Qywsg7XXVvAFdo#Tz{s0pkH2EHP7mFec9h(+A8iE{hn*ARiC+7~o z2|7bY9AJO2Qu-@1nPpu2YoL z7AC!0wU_g5w>39{%Ysc5`8{u9KdKLlr@A}ksgjojoP>lAD9F^CS7Vm%tKfW-*jPeI z763fI0f2uH06cwwCb4z-rrlu{eZ1(r}&(F_Y{EM%y zu9Z|&kB^VF%;VYEIo8)VctuQp*w_V^FDx&w%+D`qY3URem5PXpB_^l+1~ogmdW?-v zWM=1y+m@Es4!gK}MMeKAE-mjL7{dPgHRe}BcTZnSTgT6k@QH~jDQTIZ;gPz!`h|tX zzW#y0prEa-t?JtP+q*|cXBT%*pO24^{e#2gl=Rov*V6LJ)by<3k+F@9&D#3kzgwq# z{ep7yi@ZyhZS5WX1A}Gd6zYbKI@&u!!Xke+HaU5v+B-V;^bO?Y=bM;X@To-U8yFe< zNH43buKx`JHMhwrDn}&zwsOvDZfRRtS&fTN{PioYv#ZD2)O2QMHt=U?@UIe^oVlHy zT@Pm$Pj6opHI4Yhl-Bl6V?8}{3oGxSEPE@f@SnlurDZF7cZo?UJG*-$V-rLD18GUg z{$Aesg(WHx{aPxj>Ka;ESvj~QwCNey-adW4g2JVRh26dVx|&)sN$Hu%sgsjaCQjd@ zqoaoUdJ+n5UT)se;gQ{)-T2sFaVeGCTiZ>IjjJmwgQKfsqho(M|7>n-rl+K05>Q6Q zX0*4p2glUNh)YC;h7sc7lM|B&2nfzC?LouBU0(h@IlcPRx3IZ=Ix?}ox4U+xPeK@9pjFRoqw3GW>Lu#X((?0+K>uDf-h>Jn=fj)a0nX&=NudNWbEt7jnDe0W4B}5PP`N zs_2T6C8SESvt^lvcBHLC)w+wRwO`Y_0LFQF z?%t`YJhto^1eb&32TbM!;%`V!FpL@FU-K53ZC#)8FA=lq9(2~*;>kdieO0Ntv|i{8 z&R#@Eb%JBfqY0tieFl3dKAT6DO$$Da?~z$6aJLR$AfyE~_KHdDc0{4D2c{73VV0ir zum?Xe-N6xxHH=Ur>|I-qo9y-0%4zw4bJNlH~zKGRZ12X<@_AV z*5zGNLbseK1(D+~(@{&%4@f?=WQv*V401VL?Y&o}vJ0z`y(k?{*SjTzo6M+*X=!Pa zHEBd#aCe2{qNz3;pv4-5+c{VW#ep^HTeu`rtr=@Z3)Xa*H?!My75MBqKhD#U^KO>V z8TrnqUZ;h3CShW`|x*Lc;834nfOa{|wo2hU;ZZO#bC5q5F0bLz8n--rn@uQ{E~; z*38{J^g|=jZfz{n**hxS1@d$DnFX@mN1t?ilh*5h_@6^>D)nk6H3Lj?eCx?Ri4N-W zcmJ2XB4$-2_aZVVCJsjE7>bYg04OQXISuaj8#K!OmoQ@E2Phv}>mo6?+((HMFBk~uz z^v2n5l(x%BfnTaygt_vf(3Yg~+2GBGLojl7zm=tB-00hefLbQ6n%_tWVLiz_>_!sv z$ebKD!5o%|xODT4h~LoqFL;dtkbKB8&PU&W#u_)g0yP{WhjclGnR>n;PjiQ>IF)=U znj|R?9;}LeWRw0q37^fP(`Hl6QF}E(1*xQDt^HZ4EV*UqCM*fk!|?2FF;;e#W?_=^ zfN0rs9I2ncLA0-|xE+_z4`Lr?!@=Wy^NNas2--do(zsG3$)a|SUzo>a>pm$$_M`R5 zva);DjeKKjW}M2>-=zY?L$}X7@>h{P@)B$GbpCeBQKk9Fpr-Jp z32=6JdlT!+BQO6 zMnFD+YNtp3+{{^+AVW;-AMO8mJFP2dX=w}cX{t#_hIK65^z7j-PAhkMK81Hrt%{=1 zkUcRr&QiCD<*YK=-HK|6H;o7j^~7WcaJJF^u6nwRq1PRb{Li77!HA=vjZn(0LEI5K z@V@zW_@~xpqcu8s%-E!U(Z-8z+3=sceRQK2p)g=9jJ`oTx2;r+?i@t(g=qE~Uu<(* zt%kiky$5F9x8>`;(DO5Yv3F#|-`}YW6Y-p>m zi1(%Eh19j=&UtZBSV3HzIb%JO)67zt2u9|?4 zi&h(^nXHaXjLpm05%|y8(POgg6J?d?CQ;e$E+%rY&5;$u1GVP`Kdrej;_u)Rr!Xd_6H)mm zj)sO~Xmd|jZ^9!xA5<4SH!tgxy@}UFIrT3Br|JD-W8)9P42>J4_Wm)9E#alGjv6;!E-1X?&xXdO+kTQ6)oe#3i8!5{l-rYjtY&3O*o!yN72W* z#jnIRSRjEH&&+@16+E1r_7JnqabC&v1IC*TdAoCO3JdkL%IuB$T24m#dhU-PKCiNH zgT$YtLp1E%I7Tm6qhU1JnFW)!J5E=U!4PR3w8k6&pu)g+m}N8eC2yR>wIvegA$63Z z`4R@P+f8(^@p#78WW9MOwvE87qy5qB-=IY@CilQ8|Nef~a(j!N+ZaD8l%^_*ORco` zqMBM*xKh*#TOB?=c&p*96|2r3*o$ZFh`lAlaT)_8&!^4V6}MF5>ePg9#U2C z_S-e;fuwn`1Y0*VfrCjbjquVA&Q@IOZ1~Q0+F{x~;4a-Sd3}e0AzK5t-LE&D&HBD_ zSy}mI5SEC?`w;>P{`|~j&W#mO%F3rA(o}?cGIlj|;aN-s`Px=%Mm{ zYj(TSvw)?*+m*&7*T@IsF&+nQHJW_#C4>WV&d{a(Ip1kv7+Q=Dr+%~FnPLW@OV_*u zZUOyutUJlaqJC`$b%n@3SZ2sA?d}%xEc=%z`0tAhzE2sOuP<@1C=43c?^`o$9&DC( z!z~W*o%8)hq&5BW8=S_6B+Z+NWEv@Kp-bm;)tTFCOylqYyRI)yX_LZG-*y~>cwwL8 zjvzz7mfRx+uicA(C;YdD?mAaWD`;cr|9jmct9iRl`JWcB?*WK72v{~?HN^0-P@X0| z8!y%9C%(HjJPM#pa~JE>YPQe3@mUQ-SBc+dMH8X?IN@u&Jh-bZ!()#`Ih7;V(+wj= zj3IoVXNi3sWFUN6+=iAOC;@$zs~oN{6!;-1X=9WarQtO`E9LxA7rLy+d?653_m~O> zPR4U{!^Rke!P*a3(AVB~p?-8vea-tAN{%;=hqSFp8>~zI`2wS1bz-={cJJGxK>fGV zG;>0oS|D8WfC!8Ex1p1)7O%E~QX5Dq8OE2VAM)8|<|L~m2cPp+a`UQx!TMcOlcPFJ z1%JZWHPU12Xu3c=mfjslbKkG`!*yuN7lXIM)n*^}@2(h!_uXp3=q9J@QG&7;g^;cM z`p|P^dD%zZx1rv=iciAR=-Z^%wWsKK*H$wMLD&IA9M9U(M1S0_&$tKK zU2;~i!A?U%9x?h+zS4K9+N?(X3MJlh01&nbW5VCLwk%49R| zGPtDEWDXFIHp_$z%P`3riV^0kZ`8_Rz(*u%#v9>3g$!vxXhj$|#LgM+c?wj0ods~g zLKbSbawp1m@ApH9+}UflhwIxZFdu0{s#Iz`19798O8Im&({AxZu?M1P$7KuZs`S5L^agtN!>cfQ|w@++HH zI7sBCCN|jJdH1e&`h$Xmr5_@D$i9L-_!xe?xw(q4>0Uj|>w~^e(Gd z!>xe<1n7;MrpN(+ZG1<}s-HcZVEr5i>l2_!e0fx{_~+$0C;LBp$EUqI;i!vZ4cV?p z1RnjAs>2}<8V6BRqaqnPtjPZG@ol_&SlCN_GK3n*iqLfEZ;c}lB`elzbv5$$v!m~S z`^EM5_+yDpYjC3nA;S06#AU&T7RWb(t)_qkhKeqZ0IUf}g0a92r;FE;9G{y$FUrYI zmfB;9%Mm?UUtzTDipa6;A+Uifg>)1%KJT+rihNN8_nJTMv1&ErNem*U-=@ibeXDP8 z94FP5U`gVrSFU2B%I3Ad?!u!@20Jnx2~KoP(4z{6b2*d?pdo`877B>KU{$m&C|_de z%H}EPOjnUFwRPKhKVN;9_qjc=i*2tp7FQzcsNi79WrUyH=eTov)lec;Jiwzg5YF=P zuzq$dD5Tjun3(wO8J4xmr}^?VkeKNs2{WE<_o`@FGWevp>GRo=vqj-f4HZWqvGmD3 zZqww~0^K+aq}HKNrD())%_>;&>uRTGN3355MhqkSg&I6XH|sBsQJTE3_6He?F1#b< ztO~IukZgh_5vs>`it11LL^gjq3yN!Pq`$pbOZAC3mj2-fGtH>Kmped8URxF0&N=;<8>i^ULaq3R#jMTOnoRc zy`9%g_&qOkY$hsd`;3eR9?^QSK;l~+mKBO5c96^cTGi2aqJBIWw{gHUs?(roix|_* z);DLx4WQE72@xREgishX<}myUSheEHZ%wg$Z;#0gAce?MEi+E5 ztI`#hxHo(~M0wFfOm&Lq1&YE!c&HXK%lxe(^zLTaVV8(!ey#U>vX z8aI?1Fs0N)o-I16Xx>{(E_$>P)pI0*kA8P`g;AztAqx3rGLbc zHh&7^q&(|QXd22Ytvxl);mQd#1l(eT@U_&%;YkLh-V7z_H(8p2)fG#NrK)_WUiIcZ}s18y9BW_(+nMw_y z0*!Z{oB@DAk%9=IVKaZ0jgOYs25)jYJios>&CpTrushH}kuYo`vyJQ_HAYGOSEsX@ znp=Ew`*B!XgAOZpaJNpQ603zMwBT~mcE%w{t5M5JRaH?@QA%p0TbB{3myw4{rY-pX z2kS-S<$zG+3L&W1#2KFz)WR;OCo5eO*O=_y?Z>C# zea9A^i^IWf`&-WCI4-uFjq-V=ic%XML8#9FFw?qeosTm6Ly7|@dO)7wXwSWZK=%kv zFCZzTI?Ns3Gw@plM6FQ)3kec{p??x+`z@g|6>iCcRA`zS_%&oZs7v?UqF!Q2kziS4 zKQuaG(NK5eA{)2-#_7pBsCN6D`FdxO5 zaY|_z^lLW$1S^$m;_R#Q4~0XV^?k3ksZFo_d2Nb>xIMNs{Osjq{Zx~nMK)10^M}K| zf4KcucR6PMgep9_ zvj)ub5l@8bx3$xT=$!mNlCuml3Kw(XYkQrZy!rI27LMnv_;Mx>9j_2XmFOBr4p#_% z(6~AakhNH52?bb!1Gm)|1WBw67PZyuBz9-qZ%Jnd2aFXx=&k9b;n*JY&vAyzQrDHc z=d{0WahX@I5&x-xz(Y9cg26*rqd?Avk*uy-*S(&rOxJ@0W0wa2rL_uFQB8+=HqUOj z-sR9slR0H3=H-x)F$e7yMIcw!JoQ`g;hwVPL2Y3M4eD?<3x&r*@?fEW!QCtOcA-28 zDJd(eu@n_dwtzMvSTy&LjG$mZ<2yK_!jH3s2RS%lMT|ccFe8Yav)?M!V**2@^{Ux% zQ_lIZ7pYENg3g{Pg&YgHmWV?PbU!R491}xAdU{>~ zzq>SUQPm8T%UkMFo?gbtFhL~XLguUiW8c8N6#1BLMfY2T+!Zxt9GL0HEt({Q7Wl7@ z!iwA<>Zli;;N2{<;^ROrF;|wJg2L4NKd34w2$XPKl;c7@eCHanvoU>6Oi36S!Nm&- z3_Q9=!@!txN3Di^V0v~e#|mZu^N!#$1v}e2Q#R*JLs+Jl&x4rL_^3Jy5{dBpgI@4_ zavLqurRG8Zo`SIt>RDrZhG?Fg?ndP(D*gA$N?Thy4aCg*O!n>1=*NWD`Ps=re*Uo~ zxTZF5)u?4NUp=h|{Yae)33N?$X;&Z@<{uyDCk8RfC<$y)2KjC#{;Pz4;JlS6zS{xq YG?i=yuH1&;qdq`VR8FK?$RP0l0Cb!GPXGV_ literal 0 HcmV?d00001 diff --git a/docs/llvm-theme/static/navigation.png b/docs/llvm-theme/static/navigation.png new file mode 100644 index 0000000000000000000000000000000000000000..1081dc1439fb984dfa7ef627afe3c7dc476fdbce GIT binary patch literal 218 zcmeAS@N?(olHy`uVBq!ia0vp^j6iI|!3HFkf4uMuBv2gW?!>U}oXkrghqJ&VvY3H^ zTNs2H8D`Cq01C2~c>21s-(chw7$R|bZ|_0D0|q>YSbqDzW^|HYIk%*-&O)*` where ^ is one of + echo. html to make standalone HTML files + echo. dirhtml to make HTML files named index.html in directories + echo. singlehtml to make a single large HTML file + echo. pickle to make pickle files + echo. json to make JSON files + echo. htmlhelp to make HTML files and a HTML help project + echo. qthelp to make HTML files and a qthelp project + echo. devhelp to make HTML files and a Devhelp project + echo. epub to make an epub + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter + echo. text to make text files + echo. man to make manual pages + echo. texinfo to make Texinfo files + echo. gettext to make PO message catalogs + echo. changes to make an overview over all changed/added/deprecated items + echo. linkcheck to check all external links for integrity + echo. doctest to run all doctests embedded in the documentation if enabled + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "singlehtml" ( + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\llvm.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\llvm.ghc + goto end +) + +if "%1" == "devhelp" ( + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. + goto end +) + +if "%1" == "epub" ( + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub file is in %BUILDDIR%/epub. + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "text" ( + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The text files are in %BUILDDIR%/text. + goto end +) + +if "%1" == "man" ( + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The manual pages are in %BUILDDIR%/man. + goto end +) + +if "%1" == "texinfo" ( + %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. + goto end +) + +if "%1" == "gettext" ( + %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The message catalogs are in %BUILDDIR%/locale. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + if errorlevel 1 exit /b 1 + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +:end