[llvm] r206924 - [docs] Add a note to docs/README.txt

Sean Silva chisophugis at gmail.com
Tue Apr 22 14:47:54 PDT 2014


Author: silvas
Date: Tue Apr 22 16:47:53 2014
New Revision: 206924

URL: http://llvm.org/viewvc/llvm-project?rev=206924&view=rev
Log:
[docs] Add a note to docs/README.txt

Added note to docs/README.txt on how to check the reachibility of
external links in the documentation.

Patch by Dan Liew!

Modified:
    llvm/trunk/docs/README.txt

Modified: llvm/trunk/docs/README.txt
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/README.txt?rev=206924&r1=206923&r2=206924&view=diff
==============================================================================
--- llvm/trunk/docs/README.txt (original)
+++ llvm/trunk/docs/README.txt Tue Apr 22 16:47:53 2014
@@ -40,3 +40,12 @@ The correspondence between .rst files an
 These .rst files are also included during HTML generation so they are also
 viewable online (as noted above) at e.g.
 `http://llvm.org/docs/CommandGuide/Foo.html`.
+
+Checking links
+==============
+
+The reachibility of external links in the documentation can be checked by
+running:
+
+    cd docs/
+    make -f Makefile.sphinx linkcheck





More information about the llvm-commits mailing list