llvm.org GIT mirror llvm / ccb8019
docs: update docs/README.txt and make it useful. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@171353 91177308-0d34-0410-b5e6-96231b3b80d8 Sean Silva 6 years ago
1 changed file(s) with 18 addition(s) and 6 deletion(s). Raw diff Collapse all Expand all
0 LLVM Documentation
11 ==================
22
3 The LLVM documentation is currently written in two formats:
3 LLVM's documentation is written in reStructuredText, a lightweight
4 plaintext markup language (file extension `.rst`). While the
5 reStructuredText documentation should be quite readable in source form, it
6 is meant to be processed by the Sphinx documentation generation system to
7 create HTML pages which are hosted on and updated
8 after every commit.
49
5 * Plain HTML documentation.
10 If you instead would like to generate and view the HTML locally, install
11 Sphinx and then do:
612
7 * reStructured Text documentation using the Sphinx documentation generator. It
8 is currently tested with Sphinx 1.1.3.
13 cd docs/
14 make -f Makefile.sphinx
15 $BROWSER _build/html/index.html
916
10 For more information, see the "Sphinx Introduction for LLVM Developers"
11 document.
17 The mapping between reStructuredText files and generated documentation is
18 `docs/Foo.rst` <-> `_build/html/Foo.html` <-> `http://llvm.org/docs/Foo.html`.
19
20 If you are interested in writing new documentation, you will want to read
21 `SphinxQuickstartTemplate.rst` which will get you writing documentation
22 very fast and includes examples of the most important reStructuredText
23 markup syntax.