[PATCH] D112299: Replace references to Makefile.sphinx

[Sylvestre Ledru via Phabricator via llvm-commits]

This revision was landed with ongoing or failed builds.
This revision was automatically updated to reflect the committed changes.
Closed by commit rGfd5e3f36f218: Replace references to Makefile.sphinx (authored by sylvestre.ledru).

Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D112299/new/

https://reviews.llvm.org/D112299

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


Index: llvm/docs/README.txt
===================================================================
--- llvm/docs/README.txt
+++ llvm/docs/README.txt
@@ -14,7 +14,7 @@
     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 @@
     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 @@
 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
 ==============
Index: clang/include/clang/Basic/AttrDocs.td
===================================================================
--- clang/include/clang/Basic/AttrDocs.td
+++ 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 =[{..


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D112299.381528.patch
Type: text/x-patch
Size: 1696 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20211022/27af49be/attachment.bin>