Commit Graph

7 Commits

Author SHA1 Message Date
Dmitri Gribenko
755a4bbc86 Makefile.sphinx: reST conversion is complete!
No need to copy HTML files anymore.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@170029 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-12 21:35:43 +00:00
Sean Silva
ee47edfd8e 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").

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169343 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-05 00:26:32 +00:00
Justin Holewinski
19b3f3d985 Unbreak Sphinx build
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169106 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-02 02:47:48 +00:00
Eli Bendersky
1f90eb4674 Another fix attempt to Makefile.sphinx - copy the PNGs from tutorial/ as well,
and recursive copying is not required for the tutorial/ directory.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169105 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-01 22:21:04 +00:00
Eli Bendersky
c7ff36a863 Attempt to fix Makefile.sphinx to not generate errors while trying to copy
files from tutorial/.svn


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169104 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-01 22:11:59 +00:00
Michael J. Spencer
aadf715702 [Docs] Fix Sphinx incremental build. Patch by Sean Silva!
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@163235 91177308-0d34-0410-b5e6-96231b3b80d8
2012-09-05 19:44:47 +00:00
Daniel Dunbar
75083ebc09 [docs] Stub out structure for Sphinx-based docs.
- Work in progress, this is just the basic structure.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@155132 91177308-0d34-0410-b5e6-96231b3b80d8
2012-04-19 16:31:19 +00:00