File tree Expand file tree Collapse file tree 2 files changed +6
-5
lines changed
clang/include/clang/Basic Expand file tree Collapse file tree 2 files changed +6
-5
lines changed Original file line number Diff line number Diff line change 22
22
// Windows (from within the clang\docs directory):
23
23
// make.bat html
24
24
// Non-Windows (from within the clang\docs directory):
25
- // make -f Makefile.sphinx html
25
+ // sphinx-build -b html _build/ html
26
26
27
27
def GlobalDocumentation {
28
28
code Intro =[{..
Original file line number Diff line number Diff line change @@ -14,7 +14,7 @@ Sphinx <http://sphinx-doc.org/> and then do:
14
14
cd <build-dir>
15
15
cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_HTML=true <src-dir>
16
16
make -j3 docs-llvm-html
17
- $BROWSER <build-dir>/docs// html/index.html
17
+ $BROWSER <build-dir>/docs/html/index.html
18
18
19
19
The mapping between reStructuredText files and generated documentation is
20
20
`docs/Foo.rst` <-> `<build-dir>/docs//html/Foo.html` <-> `https://llvm.org/docs/Foo.html`.
@@ -35,7 +35,7 @@ directory `<build-dir>/docs/man/`.
35
35
cd <build-dir>
36
36
cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_MAN=true <src-dir>
37
37
make -j3 docs-llvm-man
38
- man -l > build-dir>/docs/man/FileCheck.1
38
+ man -l < build-dir>/docs/man/FileCheck.1
39
39
40
40
The correspondence between .rst files and man pages is
41
41
`docs/CommandGuide/Foo.rst` <-> `<build-dir>/docs//man/Foo.1`.
@@ -49,8 +49,9 @@ Checking links
49
49
The reachability of external links in the documentation can be checked by
50
50
running:
51
51
52
- cd docs/
53
- make -f Makefile.sphinx linkcheck
52
+ cd llvm/docs/
53
+ sphinx-build -b linkcheck . _build/lintcheck/
54
+ # report will be generated in _build/lintcheck/output.txt
54
55
55
56
Doxygen page Output
56
57
==============
You can’t perform that action at this time.
0 commit comments