LLVM's documentation is written in reStructuredText, a lightweight
plaintext markup language (file extension .rst). While the
reStructuredText documentation should be quite readable in source form, it
is mostly meant to be processed by the Sphinx documentation generation
system to create HTML pages which are hosted on http://llvm.org/docs/ and
updated after every commit. Manpage output is also supported, see below.
If you instead would like to generate and view the HTML locally, install Sphinx http://sphinx-doc.org/ and then do:
cd docs/
make
$BROWSER _build/html/index.html
The mapping between reStructuredText files and generated documentation is
docs/Foo.rst <-> _build/html/Foo.html <-> http://llvm.org/docs/Foo.html.
If you are interested in writing new documentation, you will want to read
SphinxQuickstartTemplate.rst which will get you writing documentation
very fast and includes examples of the most important reStructuredText
markup syntax.
Building the manpages is similar to building the HTML documentation. The
primary difference is to use the man makefile target, instead of the
default (which is html). Sphinx then produces the man pages in the
directory _build/man/.
cd docs/
make
man -l _build/man/FileCheck.1
The correspondence between .rst files and man pages is
docs/CommandGuide/Foo.rst <-> _build/man/Foo.1.
These .rst files are also included during HTML generation so they are also
viewable online (as noted above) at e.g.
http://llvm.org/docs/CommandGuide/Foo.html.
The reachability of external links in the documentation can be checked by running:
cd docs/
make linkcheck
Thanks for your time and read the following section to learn about the translation about LLVM documentation.
You can do the translation in the files located in locale/zh_CN/LCMESSAGE directory with the same name as English version.
It will be encouraged to send PR.
English version and framework belong to http://llvm.org.
All rights reserved for the Chinese version.