Skip to content

Commit fd5e3f3

Browse files
committed
Replace references to Makefile.sphinx
and fix some typos Reviewed By: aaron.ballman Differential Revision: https://reviews.llvm.org/D112299
1 parent f37463b commit fd5e3f3

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

clang/include/clang/Basic/AttrDocs.td

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
// Windows (from within the clang\docs directory):
2323
// make.bat html
2424
// Non-Windows (from within the clang\docs directory):
25-
// make -f Makefile.sphinx html
25+
// sphinx-build -b html _build/html
2626

2727
def GlobalDocumentation {
2828
code Intro =[{..

llvm/docs/README.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Sphinx <http://sphinx-doc.org/> and then do:
1414
cd <build-dir>
1515
cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_HTML=true <src-dir>
1616
make -j3 docs-llvm-html
17-
$BROWSER <build-dir>/docs//html/index.html
17+
$BROWSER <build-dir>/docs/html/index.html
1818

1919
The mapping between reStructuredText files and generated documentation is
2020
`docs/Foo.rst` <-> `<build-dir>/docs//html/Foo.html` <-> `https://llvm.org/docs/Foo.html`.
@@ -35,7 +35,7 @@ directory `<build-dir>/docs/man/`.
3535
cd <build-dir>
3636
cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_MAN=true <src-dir>
3737
make -j3 docs-llvm-man
38-
man -l >build-dir>/docs/man/FileCheck.1
38+
man -l <build-dir>/docs/man/FileCheck.1
3939

4040
The correspondence between .rst files and man pages is
4141
`docs/CommandGuide/Foo.rst` <-> `<build-dir>/docs//man/Foo.1`.
@@ -49,8 +49,9 @@ Checking links
4949
The reachability of external links in the documentation can be checked by
5050
running:
5151

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
5455

5556
Doxygen page Output
5657
==============

0 commit comments

Comments
 (0)