mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2025-01-31 20:51:52 +01:00
[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! llvm-svn: 206924
This commit is contained in:
parent
af08119374
commit
1915469aa7
@ -40,3 +40,12 @@ The correspondence between .rst files and man pages is
|
||||
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
|
||||
|
Loading…
x
Reference in New Issue
Block a user