[docs] Stub out structure for Sphinx-based docs.
[oota-llvm.git] / docs / _templates / index.html
1 {# This template defines the 'index.html' page which we currently only use as
2    the entry point to the HTML-based documentation, but later can use to provide
3    an entry point for a Sphinx based LLVM website.
4
5    Conceptually, this page is not supposed to be part of the documentation per
6    se (i.e., the content that would be rendered into a PDF, for example), but
7    rather provides entry points into the documentation and links to other
8    content which would only be part of the website. #}
9
10 {% extends "layout.html" %}
11 {% set title = 'lld' %}
12 {% block body %}
13 <h1>LLVM System Documentation</h1>
14
15 <p class="doc_warning">
16   This is the front page for the Sphinx-based LLVM documentation. This is
17   currently a work in progress.
18 </p>
19
20 <h2>Documentation</h2>
21 <table class="contentstable" align="center" style="margin-left: 30px">
22   <tr>
23     <td width="50%">
24       <p class="biglink"><a class="biglink" href="{{ pathto('contents') }}">
25           Contents</a><br/>
26         <span class="linkdescr">for a complete overview</span></p>
27       <p class="biglink"><a class="biglink" href="{{ pathto('search') }}">
28           Search page</a><br/>
29         <span class="linkdescr">search the documentation</span></p>
30       <p class="biglink"><a class="biglink" href="{{ pathto('genindex') }}">
31           General Index</a><br/>
32         <span class="linkdescr">all functions, classes, terms</span></p>
33   </td></tr>
34 </table>
35
36 <h2>Source</h2>
37 <p>LLVM is available via public SVN repository:
38   <tt>svn co
39     <a href="http://llvm.org/svn/llvm-project/llvm/trunk">
40       http://llvm.org/svn/llvm-project/llvm/trunk</a></tt>.</p>
41
42 <p>LLVM source can be browsed
43   via <a href="http://llvm.org/viewvc/llvm-project/llvm/trunk">ViewVC</a>.</p>
44
45 <p>LLVM is also available via a read-only git mirror:
46   <tt>git clone
47     <a href="http://llvm.org/git/llvm.git">
48       http://llvm.org/git/llvm.git</a></tt>.</p>
49
50 {% endblock %}