aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSean Silva <silvas@purdue.edu>2012-12-04 21:16:41 +0000
committerSean Silva <silvas@purdue.edu>2012-12-04 21:16:41 +0000
commit91b9763d53d12e5bb89a395daec9e12359e7adb4 (patch)
tree4ed385ab6de8cb899d17187e83ecab3db7ff4aec
parent1693583fe25dd3323b6b4fcd13baaaf8559977d4 (diff)
downloadexternal_llvm-91b9763d53d12e5bb89a395daec9e12359e7adb4.zip
external_llvm-91b9763d53d12e5bb89a395daec9e12359e7adb4.tar.gz
external_llvm-91b9763d53d12e5bb89a395daec9e12359e7adb4.tar.bz2
docs: Begin Sphinxification of docs/tutorial/
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169309 91177308-0d34-0410-b5e6-96231b3b80d8
-rw-r--r--docs/tutorial/index.html48
-rw-r--r--docs/tutorial/index.rst36
-rw-r--r--docs/userguides.rst3
3 files changed, 38 insertions, 49 deletions
diff --git a/docs/tutorial/index.html b/docs/tutorial/index.html
deleted file mode 100644
index 2c11a9a..0000000
--- a/docs/tutorial/index.html
+++ /dev/null
@@ -1,48 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
-<html>
-<head>
- <title>LLVM Tutorial: Table of Contents</title>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
- <meta name="author" content="Owen Anderson">
- <meta name="description"
- content="LLVM Tutorial: Table of Contents.">
- <link rel="stylesheet" href="../_static/llvm.css" type="text/css">
-</head>
-
-<body>
-
-<h1>LLVM Tutorial: Table of Contents</h1>
-
-<ol>
- <li>Kaleidoscope: Implementing a Language with LLVM
- <ol>
- <li><a href="LangImpl1.html">Tutorial Introduction and the Lexer</a></li>
- <li><a href="LangImpl2.html">Implementing a Parser and AST</a></li>
- <li><a href="LangImpl3.html">Implementing Code Generation to LLVM IR</a></li>
- <li><a href="LangImpl4.html">Adding JIT and Optimizer Support</a></li>
- <li><a href="LangImpl5.html">Extending the language: control flow</a></li>
- <li><a href="LangImpl6.html">Extending the language: user-defined operators</a></li>
- <li><a href="LangImpl7.html">Extending the language: mutable variables / SSA construction</a></li>
- <li><a href="LangImpl8.html">Conclusion and other useful LLVM tidbits</a></li>
- </ol></li>
- <li>Kaleidoscope: Implementing a Language with LLVM in Objective Caml
- <ol>
- <li><a href="OCamlLangImpl1.html">Tutorial Introduction and the Lexer</a></li>
- <li><a href="OCamlLangImpl2.html">Implementing a Parser and AST</a></li>
- <li><a href="OCamlLangImpl3.html">Implementing Code Generation to LLVM IR</a></li>
- <li><a href="OCamlLangImpl4.html">Adding JIT and Optimizer Support</a></li>
- <li><a href="OCamlLangImpl5.html">Extending the language: control flow</a></li>
- <li><a href="OCamlLangImpl6.html">Extending the language: user-defined operators</a></li>
- <li><a href="OCamlLangImpl7.html">Extending the language: mutable variables / SSA construction</a></li>
- <li><a href="OCamlLangImpl8.html">Conclusion and other useful LLVM tidbits</a></li>
- </ol></li>
- <li>Advanced Topics
- <ol>
- <li><a href="http://llvm.org/pubs/2004-09-22-LCPCLLVMTutorial.html">Writing
- an Optimization for LLVM</a></li>
- </ol></li>
-</ol>
-
-</body>
-</html>
diff --git a/docs/tutorial/index.rst b/docs/tutorial/index.rst
new file mode 100644
index 0000000..2da4212
--- /dev/null
+++ b/docs/tutorial/index.rst
@@ -0,0 +1,36 @@
+LLVM Tutorial: Table of Contents
+================================
+
+.. TODO:: Use Sphinx toctree once all of these pages are converted.
+
+#. Kaleidoscope: Implementing a Language with LLVM
+
+ #. `Tutorial Introduction and the Lexer <LangImpl1.html>`__
+ #. `Implementing a Parser and AST <LangImpl2.html>`__
+ #. `Implementing Code Generation to LLVM IR <LangImpl3.html>`__
+ #. `Adding JIT and Optimizer Support <LangImpl4.html>`__
+ #. `Extending the language: control flow <LangImpl5.html>`__
+ #. `Extending the language: user-defined operators <LangImpl6.html>`__
+ #. `Extending the language: mutable variables / SSA
+ construction <LangImpl7.html>`__
+ #. `Conclusion and other useful LLVM tidbits <LangImpl8.html>`__
+
+#. Kaleidoscope: Implementing a Language with LLVM in Objective Caml
+
+ #. `Tutorial Introduction and the Lexer <OCamlLangImpl1.html>`__
+ #. `Implementing a Parser and AST <OCamlLangImpl2.html>`__
+ #. `Implementing Code Generation to LLVM IR <OCamlLangImpl3.html>`__
+ #. `Adding JIT and Optimizer Support <OCamlLangImpl4.html>`__
+ #. `Extending the language: control flow <OCamlLangImpl5.html>`__
+ #. `Extending the language: user-defined
+ operators <OCamlLangImpl6.html>`__
+ #. `Extending the language: mutable variables / SSA
+ construction <OCamlLangImpl7.html>`__
+ #. `Conclusion and other useful LLVM tidbits <OCamlLangImpl8.html>`__
+
+#. Advanced Topics
+
+ #. `Writing an Optimization for
+ LLVM <http://llvm.org/pubs/2004-09-22-LCPCLLVMTutorial.html>`_
+
+
diff --git a/docs/userguides.rst b/docs/userguides.rst
index dd87055..81506a1 100644
--- a/docs/userguides.rst
+++ b/docs/userguides.rst
@@ -21,6 +21,7 @@ User Guides
SphinxQuickstartTemplate
Phabricator
TestingGuide
+ tutorial/index
* :ref:`getting_started`
@@ -42,7 +43,7 @@ User Guides
An addendum to the main Getting Started guide for those using Visual Studio
on Windows.
-* `LLVM Tutorial <tutorial/>`_
+* :doc:`tutorial/index`
A walk through the process of using LLVM for a custom language, and the
facilities LLVM offers in tutorial form.