Skip to content

[DOCS] Added --skiplinkcheck parameter #261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 22, 2017
Merged

[DOCS] Added --skiplinkcheck parameter #261

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ae900c9
[DOCS] Added --nolinkcheck parameter
lcawl Nov 21, 2017
49e7c01
[DOCS] Addressed feedback about -nolinkcheck option
lcawl Nov 21, 2017
bd755f7
[DOCS] Changed nolinkcheck to skiplinkcheck
lcawl Nov 22, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions build_docs.pl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ BEGIN
$Opts, #
'all', 'push', 'update!', #
'single', 'pdf', 'doc=s', 'out=s', 'toc', 'chunk=i',
'open', 'staging', 'procs=i', 'user=s', 'lang=s',
'open', 'skiplinkcheck', 'staging', 'procs=i', 'user=s', 'lang=s',
'lenient', 'verbose', 'reload_template', 'resource=s@'
) || exit usage();

Expand Down Expand Up @@ -191,12 +191,15 @@ sub build_all {
write_html_redirect( $build_dir->subdir( $_->{prefix} ),
$_->{redirect} );
}

say "Checking links";
check_links($build_dir);

push_changes($build_dir)
if $Opts->{push};
if ( $Opts->{skiplinkcheck} ) {
say "Skipped Checking links";
}
else {
say "Checking links";
check_links($build_dir);
}
push_changes($build_dir)
if $Opts->{push};
}

#===================================
Expand Down Expand Up @@ -625,6 +628,7 @@ sub usage {
--lenient Ignore linking errors
--lang Defaults to 'en'
--resource Path to image dir - may be repeated
--skiplinkcheck Omit the step that checks for broken links

WARNING: Anything in the `out` dir will be deleted!

Expand Down