docs: Sphinxify `docs/tutorial/`
authorSean Silva <silvas@purdue.edu>
Wed, 5 Dec 2012 00:26:32 +0000 (00:26 +0000)
committerSean Silva <silvas@purdue.edu>
Wed, 5 Dec 2012 00:26:32 +0000 (00:26 +0000)
commitd7fb396eb2b0539c905ed8e86486b832b499fd2b
tree80034a1a9f3c2e03d2983bd8f29a6969e29a7aa4
parente1b68aded6003d6915b68fca7c7e2417467108af
docs: Sphinxify `docs/tutorial/`

Sorry for the massive commit, but I just wanted to knock this one down
and it is really straightforward.

There are still a couple trivial (i.e. not related to the content)
things left to fix:

- Use of raw HTML links where :doc:`...` and :ref:`...` could be used
  instead. If you are a newbie and want to help fix this it would make
  for some good bite-sized patches; more experienced developers should
  be focusing on adding new content (to this tutorial or elsewhere, but
  please _do not_ waste your time on formatting when there is such dire
  need for documentation (see docs/SphinxQuickstartTemplate.rst to get
  started writing)).

- Highlighting of the kaleidoscope code blocks (currently left as bare
  `::`).  I will be working on writing a custom Pygments highlighter for
  this, mostly as training for maintaining the `llvm` code-block's lexer
  in-tree. I want to do this because I am extremely unhappy with how it
  just "gives up" on the slightest deviation from the expected syntax
  and leaves the whole code-block un-highlighted.

  More generally I am looking at writing some Sphinx extensions and
  keeping them in-tree as well, to support common use cases that
  currently have no good solution (like "monospace text inside a link").

llvm-svn: 169343
34 files changed:
llvm/docs/Makefile.sphinx
llvm/docs/tutorial/LangImpl1.html [deleted file]
llvm/docs/tutorial/LangImpl1.rst [new file with mode: 0644]
llvm/docs/tutorial/LangImpl2.html [deleted file]
llvm/docs/tutorial/LangImpl2.rst [new file with mode: 0644]
llvm/docs/tutorial/LangImpl3.html [deleted file]
llvm/docs/tutorial/LangImpl3.rst [new file with mode: 0644]
llvm/docs/tutorial/LangImpl4.html [deleted file]
llvm/docs/tutorial/LangImpl4.rst [new file with mode: 0644]
llvm/docs/tutorial/LangImpl5.html [deleted file]
llvm/docs/tutorial/LangImpl5.rst [new file with mode: 0644]
llvm/docs/tutorial/LangImpl6.html [deleted file]
llvm/docs/tutorial/LangImpl6.rst [new file with mode: 0644]
llvm/docs/tutorial/LangImpl7.html [deleted file]
llvm/docs/tutorial/LangImpl7.rst [new file with mode: 0644]
llvm/docs/tutorial/LangImpl8.html [deleted file]
llvm/docs/tutorial/LangImpl8.rst [new file with mode: 0644]
llvm/docs/tutorial/OCamlLangImpl1.html [deleted file]
llvm/docs/tutorial/OCamlLangImpl1.rst [new file with mode: 0644]
llvm/docs/tutorial/OCamlLangImpl2.html [deleted file]
llvm/docs/tutorial/OCamlLangImpl2.rst [new file with mode: 0644]
llvm/docs/tutorial/OCamlLangImpl3.html [deleted file]
llvm/docs/tutorial/OCamlLangImpl3.rst [new file with mode: 0644]
llvm/docs/tutorial/OCamlLangImpl4.html [deleted file]
llvm/docs/tutorial/OCamlLangImpl4.rst [new file with mode: 0644]
llvm/docs/tutorial/OCamlLangImpl5.html [deleted file]
llvm/docs/tutorial/OCamlLangImpl5.rst [new file with mode: 0644]
llvm/docs/tutorial/OCamlLangImpl6.html [deleted file]
llvm/docs/tutorial/OCamlLangImpl6.rst [new file with mode: 0644]
llvm/docs/tutorial/OCamlLangImpl7.html [deleted file]
llvm/docs/tutorial/OCamlLangImpl7.rst [new file with mode: 0644]
llvm/docs/tutorial/OCamlLangImpl8.html [deleted file]
llvm/docs/tutorial/OCamlLangImpl8.rst [new file with mode: 0644]
llvm/docs/tutorial/index.rst