diff --git a/clang/include/clang/Basic/AttrDocs.td b/clang/include/clang/Basic/AttrDocs.td --- a/clang/include/clang/Basic/AttrDocs.td +++ b/clang/include/clang/Basic/AttrDocs.td @@ -22,7 +22,7 @@ // Windows (from within the clang\docs directory): // make.bat html // Non-Windows (from within the clang\docs directory): -// make -f Makefile.sphinx html +// sphinx-build -b html _build/html def GlobalDocumentation { code Intro =[{.. diff --git a/llvm/docs/README.txt b/llvm/docs/README.txt --- a/llvm/docs/README.txt +++ b/llvm/docs/README.txt @@ -14,7 +14,7 @@ cd cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_HTML=true make -j3 docs-llvm-html - $BROWSER /docs//html/index.html + $BROWSER /docs/html/index.html The mapping between reStructuredText files and generated documentation is `docs/Foo.rst` <-> `/docs//html/Foo.html` <-> `https://llvm.org/docs/Foo.html`. @@ -35,7 +35,7 @@ cd cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_MAN=true make -j3 docs-llvm-man - man -l >build-dir>/docs/man/FileCheck.1 + man -l /docs/man/FileCheck.1 The correspondence between .rst files and man pages is `docs/CommandGuide/Foo.rst` <-> `/docs//man/Foo.1`. @@ -49,8 +49,9 @@ The reachability of external links in the documentation can be checked by running: - cd docs/ - make -f Makefile.sphinx linkcheck + cd llvm/docs/ + sphinx-build -b linkcheck . _build/lintcheck/ + # report will be generated in _build/lintcheck/output.txt Doxygen page Output ==============