Mercurial > hg > CbC > CbC_llvm

comparison docs/README.txt @ 122:36195a0db682

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
merging ( incomplete )
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Fri, 17 Nov 2017 20:32:31 +0900
parents 803732b1fca8
children c2174574ed3a
comparison
equal deleted inserted replaced
119:d9df2cbd60cd 122:36195a0db682
9 updated after every commit. Manpage output is also supported, see below. 9 updated after every commit. Manpage output is also supported, see below.
10 10
11 If you instead would like to generate and view the HTML locally, install 11 If you instead would like to generate and view the HTML locally, install
12 Sphinx <http://sphinx-doc.org/> and then do: 12 Sphinx <http://sphinx-doc.org/> and then do:
13 13
14 cd docs/ 14 cd <build-dir>
15 make -f Makefile.sphinx 15 cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_HTML=true <src-dir>
16 $BROWSER _build/html/index.html 16 make -j3 docs-llvm-html
17 $BROWSER <build-dir>/docs//html/index.html
17 18
18 The mapping between reStructuredText files and generated documentation is 19 The mapping between reStructuredText files and generated documentation is
19 `docs/Foo.rst` <-> `_build/html/Foo.html` <-> `http://llvm.org/docs/Foo.html`. 20 `docs/Foo.rst` <-> `<build-dir>/docs//html/Foo.html` <-> `http://llvm.org/docs/Foo.html`.
20 21
21 If you are interested in writing new documentation, you will want to read 22 If you are interested in writing new documentation, you will want to read
22 `SphinxQuickstartTemplate.rst` which will get you writing documentation 23 `SphinxQuickstartTemplate.rst` which will get you writing documentation
23 very fast and includes examples of the most important reStructuredText 24 very fast and includes examples of the most important reStructuredText
24 markup syntax. 25 markup syntax.
27 =============== 28 ===============
28 29
29 Building the manpages is similar to building the HTML documentation. The 30 Building the manpages is similar to building the HTML documentation. The
30 primary difference is to use the `man` makefile target, instead of the 31 primary difference is to use the `man` makefile target, instead of the
31 default (which is `html`). Sphinx then produces the man pages in the 32 default (which is `html`). Sphinx then produces the man pages in the
32 directory `_build/man/`. 33 directory `<build-dir>/docs/man/`.
33 34
34 cd docs/ 35 cd <build-dir>
35 make -f Makefile.sphinx man 36 cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_MAN=true <src-dir>
36 man -l _build/man/FileCheck.1 37 make -j3 docs-llvm-man
38 man -l >build-dir>/docs/man/FileCheck.1
37 39
38 The correspondence between .rst files and man pages is 40 The correspondence between .rst files and man pages is
39 `docs/CommandGuide/Foo.rst` <-> `_build/man/Foo.1`. 41 `docs/CommandGuide/Foo.rst` <-> `<build-dir>/docs//man/Foo.1`.
40 These .rst files are also included during HTML generation so they are also 42 These .rst files are also included during HTML generation so they are also
41 viewable online (as noted above) at e.g. 43 viewable online (as noted above) at e.g.
42 `http://llvm.org/docs/CommandGuide/Foo.html`. 44 `http://llvm.org/docs/CommandGuide/Foo.html`.
43 45
44 Checking links 46 Checking links
47 The reachability of external links in the documentation can be checked by 49 The reachability of external links in the documentation can be checked by
48 running: 50 running:
49 51
50 cd docs/ 52 cd docs/
51 make -f Makefile.sphinx linkcheck 53 make -f Makefile.sphinx linkcheck
54
55 Doxygen page Output
56 ==============
57
58 Install doxygen <http://www.stack.nl/~dimitri/doxygen/download.html> and dot2tex <https://dot2tex.readthedocs.io/en/latest>.
59
60 cd <build-dir>
61 cmake -DLLVM_ENABLE_DOXYGEN=On <llvm-top-src-dir>
62 make doxygen-llvm # for LLVM docs
63 make doxygen-clang # for clang docs
64
65 It will generate html in
66
67 <build-dir>/docs/doxygen/html # for LLVM docs
68 <build-dir>/tools/clang/docs/doxygen/html # for clang docs