[llvm] fd5e3f3 - Replace references to Makefile.sphinx

[Sylvestre Ledru via llvm-commits]

Author: Sylvestre Ledru
Date: 2021-10-22T15:32:12+02:00
New Revision: fd5e3f36f2186855966978c0e11b716277eee387

URL: https://github.com/llvm/llvm-project/commit/fd5e3f36f2186855966978c0e11b716277eee387
DIFF: https://github.com/llvm/llvm-project/commit/fd5e3f36f2186855966978c0e11b716277eee387.diff

LOG: Replace references to Makefile.sphinx

and fix some typos

Reviewed By: aaron.ballman

Differential Revision: https://reviews.llvm.org/D112299

Added: 
    

Modified: 
    clang/include/clang/Basic/AttrDocs.td
    llvm/docs/README.txt

Removed: 
    


################################################################################
diff  --git a/clang/include/clang/Basic/AttrDocs.td b/clang/include/clang/Basic/AttrDocs.td
index 71f947687a08f..09477d6c4423d 100644
--- 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
index c36a533fb0050..074606c7bd36e 100644
--- a/llvm/docs/README.txt
+++ b/llvm/docs/README.txt
@@ -14,7 +14,7 @@ Sphinx <http://sphinx-doc.org/> and then do:
     cd <build-dir>
     cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_HTML=true <src-dir>
     make -j3 docs-llvm-html
-    $BROWSER <build-dir>/docs//html/index.html
+    $BROWSER <build-dir>/docs/html/index.html
 
 The mapping between reStructuredText files and generated documentation is
 `docs/Foo.rst` <-> `<build-dir>/docs//html/Foo.html` <-> `https://llvm.org/docs/Foo.html`.
@@ -35,7 +35,7 @@ directory `<build-dir>/docs/man/`.
     cd <build-dir>
     cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_MAN=true <src-dir>
     make -j3 docs-llvm-man
-    man -l >build-dir>/docs/man/FileCheck.1
+    man -l <build-dir>/docs/man/FileCheck.1
 
 The correspondence between .rst files and man pages is
 `docs/CommandGuide/Foo.rst` <-> `<build-dir>/docs//man/Foo.1`.
@@ -49,8 +49,9 @@ Checking links
 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
 ==============