diff options
| author | mkanat%bugzilla.org <> | 2006-09-06 04:00:55 +0200 |
|---|---|---|
| committer | mkanat%bugzilla.org <> | 2006-09-06 04:00:55 +0200 |
| commit | 40ee28bac9e9524eeaaa52f48cc24c950b918d1e (patch) | |
| tree | df221ccb31151c7a8df9bf5701140297082acefc /docs/makedocs.pl | |
| parent | 971d73458f19eb7d1a3600ee7bfd11b16cbc698a (diff) | |
| download | bugzilla-40ee28bac9e9524eeaaa52f48cc24c950b918d1e.tar.gz bugzilla-40ee28bac9e9524eeaaa52f48cc24c950b918d1e.tar.xz | |
Bug 350613: Bugzilla should ship with built perldoc
Patch By Max Kanat-Alexander <mkanat@bugzilla.org> r=colin, a=myk
Diffstat (limited to 'docs/makedocs.pl')
| -rw-r--r-- | docs/makedocs.pl | 70 |
1 files changed, 60 insertions, 10 deletions
diff --git a/docs/makedocs.pl b/docs/makedocs.pl index 1b83e5d7a..f74f87cc3 100644 --- a/docs/makedocs.pl +++ b/docs/makedocs.pl @@ -21,17 +21,35 @@ # Contributor(s): Matthew Tuck <matty@chariot.net.au> # Jacob Steenhagen <jake@bugzilla.org> # Colin Ogilvie <colin.ogilvie@gmail.com> +# Max Kanat-Alexander <mkanat@bugzilla.org> # This script compiles all the documentation. -use diagnostics; use strict; -use File::Basename; -use lib(".."); -use Bugzilla::Install::Requirements qw (REQUIRED_MODULES OPTIONAL_MODULES MOD_PERL_MODULES); -use Bugzilla::Constants qw (DB_MODULE); -chdir dirname($0); +# We need to be in this directory to use our libraries. +BEGIN { + require File::Basename; + import File::Basename qw(dirname); + chdir dirname($0); +} + +use lib qw(.. lib); + +# We only compile our POD if Pod::Simple is installed. We do the checks +# this way so that if there's a compile error in Pod::Simple::HTML::Bugzilla, +# makedocs doesn't just silently fail, but instead actually tells us there's +# a compile error. +my $pod_simple; +if (eval { require Pod::Simple }) { + require Pod::Simple::HTMLBatch::Bugzilla; + require Pod::Simple::HTML::Bugzilla; + $pod_simple = 1; +}; + +use Bugzilla::Install::Requirements + qw(REQUIRED_MODULES OPTIONAL_MODULES MOD_PERL_MODULES); +use Bugzilla::Constants qw(DB_MODULE BUGZILLA_VERSION); ############################################################################### # Generate minimum version list @@ -116,14 +134,44 @@ sub MakeDocs { } +sub make_pod { + + print "Creating API documentation...\n"; + + my $converter = Pod::Simple::HTMLBatch::Bugzilla->new; + # Don't output progress information. + $converter->verbose(0); + $converter->html_render_class('Pod::Simple::HTML::Bugzilla'); + + my $doctype = Pod::Simple::HTML::Bugzilla->DOCTYPE; + my $content_type = Pod::Simple::HTML::Bugzilla->META_CT; + my $bz_version = BUGZILLA_VERSION; + + my $contents_start = <<END_HTML; +$doctype +<html> + <head> + $content_type + <title>Bugzilla $bz_version API Documentation</title> + </head> + <body class="contentspage"> + <h1>Bugzilla $bz_version API Documentation</h1> +END_HTML + + $converter->contents_page_start($contents_start); + $converter->contents_page_end("</body></html>"); + $converter->add_css('style.css'); + $converter->javascript_flurry(0); + $converter->css_flurry(0); + $converter->batch_convert(['../'], 'html/api/'); + + print "\n"; +} + ############################################################################### # Make the docs ... ############################################################################### -if (!-d 'html') { - unlink 'html'; - mkdir 'html', 0755; -} if (!-d 'txt') { unlink 'txt'; mkdir 'txt', 0755; @@ -133,6 +181,8 @@ if (!-d 'pdf') { mkdir 'pdf', 0755; } +make_pod() if $pod_simple; + chdir 'html'; MakeDocs('separate HTML', "jade -t sgml -i html -d $LDP_HOME/ldp.dsl\#html " . |