From 91b9763d53d12e5bb89a395daec9e12359e7adb4 Mon Sep 17 00:00:00 2001 From: Sean Silva Date: Tue, 4 Dec 2012 21:16:41 +0000 Subject: [PATCH] docs: Begin Sphinxification of docs/tutorial/ git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169309 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/tutorial/index.html | 48 ---------------------------------------- docs/tutorial/index.rst | 36 ++++++++++++++++++++++++++++++ docs/userguides.rst | 3 ++- 3 files changed, 38 insertions(+), 49 deletions(-) delete mode 100644 docs/tutorial/index.html create mode 100644 docs/tutorial/index.rst diff --git a/docs/tutorial/index.html b/docs/tutorial/index.html deleted file mode 100644 index 2c11a9a48b3..00000000000 --- a/docs/tutorial/index.html +++ /dev/null @@ -1,48 +0,0 @@ - - - - LLVM Tutorial: Table of Contents - - - - - - - - -

LLVM Tutorial: Table of Contents

- -
    -
  1. Kaleidoscope: Implementing a Language with LLVM -
      -
    1. Tutorial Introduction and the Lexer
      2. -
    2. Implementing a Parser and AST
      3. -
    3. Implementing Code Generation to LLVM IR
      4. -
    4. Adding JIT and Optimizer Support
      5. -
    5. Extending the language: control flow
      6. -
    6. Extending the language: user-defined operators
      7. -
    7. Extending the language: mutable variables / SSA construction
      8. -
    8. Conclusion and other useful LLVM tidbits
      9. -
    2. -
  2. Kaleidoscope: Implementing a Language with LLVM in Objective Caml -
      -
    1. Tutorial Introduction and the Lexer
      2. -
    2. Implementing a Parser and AST
      3. -
    3. Implementing Code Generation to LLVM IR
      4. -
    4. Adding JIT and Optimizer Support
      5. -
    5. Extending the language: control flow
      6. -
    6. Extending the language: user-defined operators
      7. -
    7. Extending the language: mutable variables / SSA construction
      8. -
    8. Conclusion and other useful LLVM tidbits
      9. -
    3. -
  3. Advanced Topics -
      -
    1. Writing - an Optimization for LLVM
      2. -
    4. -
- - - diff --git a/docs/tutorial/index.rst b/docs/tutorial/index.rst new file mode 100644 index 00000000000..2da4212e565 --- /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 `__ + #. `Implementing a Parser and AST `__ + #. `Implementing Code Generation to LLVM IR `__ + #. `Adding JIT and Optimizer Support `__ + #. `Extending the language: control flow `__ + #. `Extending the language: user-defined operators `__ + #. `Extending the language: mutable variables / SSA + construction `__ + #. `Conclusion and other useful LLVM tidbits `__ + +#. Kaleidoscope: Implementing a Language with LLVM in Objective Caml + + #. `Tutorial Introduction and the Lexer `__ + #. `Implementing a Parser and AST `__ + #. `Implementing Code Generation to LLVM IR `__ + #. `Adding JIT and Optimizer Support `__ + #. `Extending the language: control flow `__ + #. `Extending the language: user-defined + operators `__ + #. `Extending the language: mutable variables / SSA + construction `__ + #. `Conclusion and other useful LLVM tidbits `__ + +#. Advanced Topics + + #. `Writing an Optimization for + LLVM `_ + + diff --git a/docs/userguides.rst b/docs/userguides.rst index dd870552b11..81506a1685c 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 `_ +* :doc:`tutorial/index` A walk through the process of using LLVM for a custom language, and the facilities LLVM offers in tutorial form. -- 2.34.1