Lines Matching +full:documentation +full:- +full:links

1 LLVM Documentation
4 LLVM's documentation is written in reStructuredText, a lightweight
6 reStructuredText documentation should be quite readable in source form, it
7 is mostly meant to be processed by the Sphinx documentation generation
12 Sphinx <http://sphinx-doc.org/> and then do:
14     cd <build-dir>
15     cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_HTML=true <src-dir>
16     make -j3 docs-llvm-html
17     $BROWSER <build-dir>/docs//html/index.html
19 The mapping between reStructuredText files and generated documentation is
20 `docs/Foo.rst` <-> `<build-dir>/docs//html/Foo.html` <-> `http://llvm.org/docs/Foo.html`.
22 If you are interested in writing new documentation, you will want to read
23 `SphinxQuickstartTemplate.rst` which will get you writing documentation
30 Building the manpages is similar to building the HTML documentation. The
33 directory `<build-dir>/docs/man/`.
35     cd <build-dir>
36     cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_MAN=true <src-dir>
37     make -j3 docs-llvm-man
38     man -l >build-dir>/docs/man/FileCheck.1
41 `docs/CommandGuide/Foo.rst` <-> `<build-dir>/docs//man/Foo.1`.
46 Checking links
49 The reachability of external links in the documentation can be checked by
53     make -f Makefile.sphinx linkcheck