DOC: Add first version of updated documentation.

This commit is contained in:
Travis E. Oliphant 2012-08-09 13:53:21 -05:00
commit 415c01f745
19 changed files with 474 additions and 595 deletions

View file

@ -1,24 +1,12 @@
+------------------------------------+
| layout: page |
+------------------------------------+
| title: "Kaleidoscope: Chapter 1" |
+------------------------------------+
Tutorial Introduction and the Lexer
===================================
*************************************************
Chapter 1: Tutorial Introduction and the Lexer
*************************************************
Written by `Chris Lattner <mailto:sabre@nondot.org>`_ and `Max
Shawabkeh <http://max99x.com>`_
**Chapter 1**
- This will become a table of contents (this text will be scraped).
{:toc}
`**Chapter 2: Implementing a Parser and AST** <PythonLangImpl2.html>`_
Introduction
============
=========
Welcome to the "Implementing a language with LLVM" tutorial. This
tutorial runs through the implementation of a simple language, showing

View file

@ -1,22 +1,10 @@
+------------------------------------+
| layout: page |
+------------------------------------+
| title: "Kaleidoscope: Chapter 2" |
+------------------------------------+
Implementing a Parser and AST
=============================
***************************************************
Chapter 2: Implementing a Parser and AST
***************************************************
Written by `Chris Lattner <mailto:sabre@nondot.org>`_ and `Max
Shawabkeh <http://max99x.com>`_
**Chapter 2**
- This will become a table of contents (this text will be scraped).
{:toc}
**`Chapter 3: Code generation to LLVM IR <PythonLangImpl3.html>`_**
Introduction # {#intro}
=======================

View file

@ -1,23 +1,10 @@
+------------------------------------+
| layout: page |
+------------------------------------+
| title: "Kaleidoscope: Chapter 3" |
+------------------------------------+
Code generation to LLVM IR
==========================
*******************************************
Chapter 3: Code generation to LLVM IR
*******************************************
Written by `Chris Lattner <mailto:sabre@nondot.org>`_ and `Max
Shawabkeh <http://max99x.com>`_
**Chapter 3**
- This will become a table of contents (this text will be scraped).
{:toc}
**`Chapter 4: Adding JIT and Optimizer
Support <PythonLangImpl4.html>`_**
Introduction # {#intro}
=======================
@ -32,7 +19,7 @@ and parser than it is to generate LLVM IR code. :)
**Please note**: the code in this chapter and later requires llvmpy 0.6
and LLVM 2.7. Earlier versions will most likely not work with it. Also
note that you need to use a version of this tutorial that matches your
llvmpy release: If you are using an official llvm-py release, use the
llvmpy release: If you are using an official llvmpy release, use the
version of the documentation on the `llvmpy examples
page <http://www.mdevan.org/llvmpy/examples.html>`_

View file

@ -1,23 +1,10 @@
+------------------------------------+
| layout: page |
+------------------------------------+
| title: "Kaleidoscope: Chapter 4" |
+------------------------------------+
Adding JIT and Optimizer Support
================================
*************************************************
Chapter 4: Adding JIT and Optimizer Support
*************************************************
Written by `Chris Lattner <mailto:sabre@nondot.org>`_ and `Max
Shawabkeh <http://max99x.com>`_
**Chapter 4**
- This will become a table of contents (this text will be scraped).
{:toc}
**`Chapter 5: Extending the Language: Control
Flow <PythonLangImpl5.html>`_**
Introduction # {#intro}
=======================

View file

@ -1,23 +1,10 @@
+------------------------------------+
| layout: page |
+------------------------------------+
| title: "Kaleidoscope: Chapter 5" |
+------------------------------------+
Extending the Language: Control Flow
====================================
*****************************************************
Chapter 5: Extending the Language: Control Flow
*****************************************************
Written by `Chris Lattner <mailto:sabre@nondot.org>`_ and `Max
Shawabkeh <http://max99x.com>`_
**Chapter 5**
- This will become a table of contents (this text will be scraped).
{:toc}
**`Chapter 6: Extending the Language: User-defined
Operators <PythonLangImpl6.html>`_**
Introduction # {#intro}
=======================

View file

@ -1,23 +1,10 @@
+------------------------------------+
| layout: page |
+------------------------------------+
| title: "Kaleidoscope: Chapter 6" |
+------------------------------------+
Extending the Language: User-defined Operators
==============================================
**********************************************************************
Chapter 6: Extending the Language: User-defined Operators
**********************************************************************
Written by `Chris Lattner <mailto:sabre@nondot.org>`_ and `Max
Shawabkeh <http://max99x.com>`_
**Chapter 6**
- This will become a table of contents (this text will be scraped).
{:toc}
**`Chapter 7: Extending the Language: Mutable Variables / SSA
Construction <PythonLangImpl7.html>`_**
Introduction # {#intro}
=======================

View file

@ -1,23 +1,10 @@
+------------------------------------+
| layout: page |
+------------------------------------+
| title: "Kaleidoscope: Chapter 7" |
+------------------------------------+
Extending the Language: Mutable Variables / SSA construction
============================================================
*******************************************************************************
Chapter 7: Extending the Language: Mutable Variables / SSA construction
*******************************************************************************
Written by `Chris Lattner <mailto:sabre@nondot.org>`_ and `Max
Shawabkeh <http://max99x.com>`_
**Chapter 7**
- This will become a table of contents (this text will be scraped).
{:toc}
**`Chapter 8: Conclusion and other useful LLVM
tidbits <PythonLangImpl8.html>`_**
Introduction # {#intro}
=======================

View file

@ -1,18 +1,9 @@
+------------------------------------+
| layout: page |
+------------------------------------+
| title: "Kaleidoscope: Chapter 8" |
+------------------------------------+
Conclusion and other useful LLVM tidbits
========================================
*****************************************************************
Chapter 8: Conclusion and other useful LLVM tidbits
*****************************************************************
Written by `Chris Lattner <mailto:sabre@nondot.org>`_
**Chapter 8**
- This will become a table of contents (this text will be scraped).
{:toc}
Tutorial Conclusion # {#conclusion}
===================================

View file

@ -0,0 +1,21 @@
Kaleidoscope
--------------
Implementing a Language with LLVM
The LLVM `Kaleidoscope <http://www.llvm.org/docs/tutorial/>`_ tutorial
has been ported to llvmpy by Max Shawabkeh.
.. toctree::
:titlesonly:
:numbered:
PythonLangImpl1.rst
PythonLangImpl2.rst
PythonLangImpl3.rst
PythonLangImpl4.rst
PythonLangImpl5.rst
PythonLangImpl6.rst
PythonLangImpl7.rst
PythonLangImpl8.rst