summaryrefslogtreecommitdiff
path: root/docs/_templates
diff options
context:
space:
mode:
authorDaniel Dunbar <daniel@zuster.org>2012-04-19 16:31:19 +0000
committerDaniel Dunbar <daniel@zuster.org>2012-04-19 16:31:19 +0000
commit75083ebc09a3dd47099e3912ac090dbc907f3eaf (patch)
tree20edebe81dacd338dd222b40866b9102424693f4 /docs/_templates
parent90275ea2ee7c7a960a3567926140b26a526b0aa1 (diff)
downloadllvm-75083ebc09a3dd47099e3912ac090dbc907f3eaf.tar.gz
llvm-75083ebc09a3dd47099e3912ac090dbc907f3eaf.tar.bz2
llvm-75083ebc09a3dd47099e3912ac090dbc907f3eaf.tar.xz
[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
Diffstat (limited to 'docs/_templates')
-rw-r--r--docs/_templates/index.html50
-rw-r--r--docs/_templates/indexsidebar.html7
-rw-r--r--docs/_templates/layout.html13
3 files changed, 70 insertions, 0 deletions
diff --git a/docs/_templates/index.html b/docs/_templates/index.html
new file mode 100644
index 0000000000..efd2a15726
--- /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 %}
+<h1>LLVM System Documentation</h1>
+
+<p class="doc_warning">
+ This is the front page for the Sphinx-based LLVM documentation. This is
+ currently a work in progress.
+</p>
+
+<h2>Documentation</h2>
+<table class="contentstable" align="center" style="margin-left: 30px">
+ <tr>
+ <td width="50%">
+ <p class="biglink"><a class="biglink" href="{{ pathto('contents') }}">
+ Contents</a><br/>
+ <span class="linkdescr">for a complete overview</span></p>
+ <p class="biglink"><a class="biglink" href="{{ pathto('search') }}">
+ Search page</a><br/>
+ <span class="linkdescr">search the documentation</span></p>
+ <p class="biglink"><a class="biglink" href="{{ pathto('genindex') }}">
+ General Index</a><br/>
+ <span class="linkdescr">all functions, classes, terms</span></p>
+ </td></tr>
+</table>
+
+<h2>Source</h2>
+<p>LLVM is available via public SVN repository:
+ <tt>svn co
+ <a href="http://llvm.org/svn/llvm-project/llvm/trunk">
+ http://llvm.org/svn/llvm-project/llvm/trunk</a></tt>.</p>
+
+<p>LLVM source can be browsed
+ via <a href="http://llvm.org/viewvc/llvm-project/llvm/trunk">ViewVC</a>.</p>
+
+<p>LLVM is also available via a read-only git mirror:
+ <tt>git clone
+ <a href="http://llvm.org/git/llvm.git">
+ http://llvm.org/git/llvm.git</a></tt>.</p>
+
+{% endblock %}
diff --git a/docs/_templates/indexsidebar.html b/docs/_templates/indexsidebar.html
new file mode 100644
index 0000000000..416174279c
--- /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. #}
+
+<h3>Bugs</h3>
+
+<p>LLVM bugs should be reported to
+ <a href="http://llvm.org/bugs">Bugzilla</a>.</p>
diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html
new file mode 100644
index 0000000000..4999488120
--- /dev/null
+++ b/docs/_templates/layout.html
@@ -0,0 +1,13 @@
+{% extends "!layout.html" %}
+
+{% block extrahead %}
+<style type="text/css">
+ table.right { float: right; margin-left: 20px; }
+ table.right td { border: 1px solid #ccc; }
+</style>
+{% endblock %}
+
+{% block rootrellink %}
+ <li><a href="{{ pathto('index') }}">LLVM Home</a>&nbsp;|&nbsp;</li>
+ <li><a href="{{ pathto('contents') }}">Documentation</a>&raquo;</li>
+{% endblock %}