[llvm-commits] [llvm] r169309 - in /llvm/trunk/docs: tutorial/index.html tutorial/index.rst userguides.rst

Sean Silva silvas at purdue.edu
Tue Dec 4 13:16:41 PST 2012


Author: silvas
Date: Tue Dec  4 15:16:41 2012
New Revision: 169309

URL: http://llvm.org/viewvc/llvm-project?rev=169309&view=rev
Log:
docs: Begin Sphinxification of docs/tutorial/

Added:
    llvm/trunk/docs/tutorial/index.rst
Removed:
    llvm/trunk/docs/tutorial/index.html
Modified:
    llvm/trunk/docs/userguides.rst

Removed: llvm/trunk/docs/tutorial/index.html
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/tutorial/index.html?rev=169308&view=auto
==============================================================================
--- llvm/trunk/docs/tutorial/index.html (original)
+++ llvm/trunk/docs/tutorial/index.html (removed)
@@ -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>

Added: llvm/trunk/docs/tutorial/index.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/tutorial/index.rst?rev=169309&view=auto
==============================================================================
--- llvm/trunk/docs/tutorial/index.rst (added)
+++ llvm/trunk/docs/tutorial/index.rst Tue Dec  4 15:16:41 2012
@@ -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>`_
+
+

Modified: llvm/trunk/docs/userguides.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/userguides.rst?rev=169309&r1=169308&r2=169309&view=diff
==============================================================================
--- llvm/trunk/docs/userguides.rst (original)
+++ llvm/trunk/docs/userguides.rst Tue Dec  4 15:16:41 2012
@@ -21,6 +21,7 @@
    SphinxQuickstartTemplate
    Phabricator
    TestingGuide
+   tutorial/index
 
 * :ref:`getting_started`
     
@@ -42,7 +43,7 @@
    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.





More information about the llvm-commits mailing list