summaryrefslogtreecommitdiffstats
path: root/common/waf.py
diff options
context:
space:
mode:
authorAmar Takhar <amar@rtems.org>2016-01-19 23:00:32 -0500
committerAmar Takhar <verm@darkbeer.org>2016-05-02 20:51:25 -0400
commited3794ea3926f3e8ee801eae908bb7557cb30637 (patch)
treeaa77923cc3709e697670b7bf72765dbcc0f6d2fb /common/waf.py
parentRemove incorrect pdflatex/makeindex check. (diff)
downloadrtems-docs-ed3794ea3926f3e8ee801eae908bb7557cb30637.tar.bz2
Add 'waf linkcheck' to check external references.
Diffstat (limited to '')
-rw-r--r--common/waf.py16
1 files changed, 15 insertions, 1 deletions
diff --git a/common/waf.py b/common/waf.py
index ef92a71..faf7ed5 100644
--- a/common/waf.py
+++ b/common/waf.py
@@ -29,12 +29,27 @@ def cmd_spell(ctx):
call(cmd)
+def cmd_linkcheck(ctx, conf_dir=".", source_dir="."):
+ ctx(
+ rule = "${BIN_SPHINX_BUILD} -b linkcheck -c %s -j %d -d build/doctrees %s build/linkcheck" % (conf_dir, ctx.options.jobs, source_dir),
+ cwd = ctx.path.abspath(),
+ source = ctx.path.ant_glob('**/*.rst'),
+ target = "linkcheck/output.txt"
+ )
+
+
class spell(BuildContext):
__doc__ = "Check spelling. Supply a list of files or a glob (*.rst)"
cmd = 'spell'
fun = 'cmd_spell'
+class linkcheck(BuildContext):
+ __doc__ = "Check all external URL references."
+ cmd = 'linkcheck'
+ fun = 'cmd_linkcheck'
+
+
def check_sphinx_version(ctx, minver):
version = ctx.cmd_and_log(ctx.env.BIN_SPHINX_BUILD + ['--version']).split(" ")[-1:][0]
ver = tuple(map(int, version.split(".")))
@@ -79,7 +94,6 @@ def doc_pdf(ctx, source_dir, conf_dir):
prompt = 0
)
-
def doc_singlehtml(ctx, source_dir, conf_dir):
if not ctx.env.BIN_INLINER:
ctx.fatal("Node inliner is required install with 'npm install -g inliner' (https://github.com/remy/inliner)")