[Python-checkins] r60497 - python/trunk/Doc/Makefile python/trunk/Doc/README.txt

Fri Feb 1 16:50:16 CET 2008

Author: georg.brandl
Date: Fri Feb 1 16:50:15 2008
New Revision: 60497
Modified:
 python/trunk/Doc/Makefile
 python/trunk/Doc/README.txt
Log:
Add link checker builder, written for GHOP by Thomas Lamb.
Modified: python/trunk/Doc/Makefile
==============================================================================

--- python/trunk/Doc/Makefile	(original)
+++ python/trunk/Doc/Makefile	Fri Feb 1 16:50:15 2008
@@ -16,11 +16,12 @@
 
 help:
 	@echo "Please use \`make <target>' where <target> is one of"
-	@echo " html to make standalone HTML files"
-	@echo " web to make file usable by Sphinx.web"
-	@echo " htmlhelp to make HTML files and a HTML help project"
-	@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
-	@echo " changes to make an overview over all changed/added/deprecated items"
+	@echo " html to make standalone HTML files"
+	@echo " web to make file usable by Sphinx.web"
+	@echo " htmlhelp to make HTML files and a HTML help project"
+	@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo " changes to make an overview over all changed/added/deprecated items"
+	@echo " linkcheck to check all external links for integrity"
 
 checkout:
 	@if [ ! -d tools/sphinx ]; then \
@@ -71,6 +72,11 @@
 changes: build
 	@echo "The overview file is in build/changes."
 
+linkcheck: BUILDER = linkcheck
+linkcheck: build
+	@echo "Link check complete; look for any errors in the above or in" \
+	 "build/$(BUILDER)/output.txt"
+
 clean:
 	-rm -rf build/*
 	-rm -rf tools/sphinx
Modified: python/trunk/Doc/README.txt
==============================================================================
--- python/trunk/Doc/README.txt	(original)
+++ python/trunk/Doc/README.txt	Fri Feb 1 16:50:15 2008
@@ -50,6 +50,10 @@
 
 * "latex", which builds LaTeX source files that can be run with "pdflatex"
 to produce PDF documents.
+ 
+ * "linkcheck", which checks all external references to see whether they are
+ broken, redirected or malformed, and outputs this information to stdout
+ as well as a plain-text (.txt) file.
 
 * "changes", which builds an overview over all versionadded/versionchanged/
 deprecated items in the current version. This is meant as a help for the
