summaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
authorDaniel Dunbar <daniel@zuster.org>2012-04-19 16:31:37 +0000
committerDaniel Dunbar <daniel@zuster.org>2012-04-19 16:31:37 +0000
commit21e993c1b1083ef91441a363997d0efc8e646191 (patch)
tree1c07b2ea2dd18b8219d46415cee365abc93578e2 /docs/index.rst
parent75083ebc09a3dd47099e3912ac090dbc907f3eaf (diff)
downloadllvm-21e993c1b1083ef91441a363997d0efc8e646191.tar.gz
llvm-21e993c1b1083ef91441a363997d0efc8e646191.tar.bz2
llvm-21e993c1b1083ef91441a363997d0efc8e646191.tar.xz
[docs] Convert docs index page into Sphinx.
- Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to comeā€¦ - PR12589 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@155133 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst70
1 files changed, 70 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000000..ca31efaf17
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,70 @@
+.. _contents:
+
+Overview
+========
+
+.. warning::
+
+ If you are using a released version of LLVM, see `the download page
+ <http://llvm.org/releases/>`_ to find your documentation.
+
+The LLVM compiler infrastructure supports a wide range of projects, from
+industrial strength compilers to specialized JIT applications to small
+research projects.
+
+Similarly, documentation is broken down into several high-level groupings
+targetted at different audiences:
+
+ * **Design & Overview**
+
+ Several introductory papers and presentations are available at
+ :ref:`design_and_overview`.
+
+ * **Publications**
+
+ The list of `publications <http://llvm.org/pubs>`_ based on LLVM.
+
+ * **User Guides**
+
+ Those new to the LLVM system should first vist the :ref:`userguides`.
+
+ NOTE: If you are a user who is only interested in using LLVM-based
+ compilers, you should look into `Clang <http://clang.llvm.org>`_ or
+ `DragonEgg <http://dragonegg.llvm.org>`_ instead. The documentation here is
+ intended for users who have a need to work with the intermediate LLVM
+ representation.
+
+ * **API Clients**
+
+ Developers of applications which use LLVM as a library should visit the
+ :ref:`programming`.
+
+ * **Subsystems**
+
+ API clients and LLVM developers may be interested in the
+ :ref:`subsystems` documentation.
+
+ * **Development Process**
+
+ Additional documentation on the LLVM project can be found at
+ :ref:`development_process`.
+
+ * **Mailing Lists**
+
+ For more information, consider consulting the LLVM :ref:`mailing_lists`.
+
+.. toctree::
+ :maxdepth: 2
+
+ design_and_overview
+ userguides
+ programming
+ subsystems
+ development_process
+ mailing_lists
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`