4 LLVM's documentation is written in reStructuredText, a lightweight
5 plaintext markup language (file extension `.rst`). While the
6 reStructuredText documentation should be quite readable in source form, it
7 is meant to be processed by the Sphinx documentation generation system to
8 create HTML pages which are hosted on <http://llvm.org/docs/> and updated
11 If you instead would like to generate and view the HTML locally, install
12 Sphinx <http://sphinx-doc.org/> and then do:
15 make -f Makefile.sphinx
16 $BROWSER _build/html/index.html
18 The mapping between reStructuredText files and generated documentation is
19 `docs/Foo.rst` <-> `_build/html/Foo.html` <-> `http://llvm.org/docs/Foo.html`.
21 If you are interested in writing new documentation, you will want to read
22 `SphinxQuickstartTemplate.rst` which will get you writing documentation
23 very fast and includes examples of the most important reStructuredText