sergiotarxz/Peace
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improving the hrefs.

Browse Source
This commit is contained in:
sergiotarxz 2022-03-17 18:52:24 +01:00
parent cce5201ddd
commit b17bc3b8dc
10 changed files with 62 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
bin/generate_documentation.pl
View File

@ -9,6 +9,8 @@ use Data::Dumper;
use Path::Tiny qw/path/; use Path::Tiny qw/path/;
use Mojo::Template; use Mojo::Template;
use Mojo::DOM;
use File::pushd;
my $current_dir = path(__FILE__)->parent->parent->child('lib'); my $current_dir = path(__FILE__)->parent->parent->child('lib');
@ -19,9 +21,7 @@ $current_dir->visit(
return if $path !~ /\.pm$/; return if $path !~ /\.pm$/;
system mkdir => '-pv', 'doc/' . $path->parent; system mkdir => '-pv', 'doc/' . $path->parent;
system pod2html => $path, system pod2html => $path,
'-o', 'doc/' . $path . '.html', '--htmldir', '-o', 'doc/' . $path . '.html', '--recurse';
$current_dir->child('./doc')->realpath, '--podpath', 'lib',
'--recurse';
} }
}, },
{ recurse => 1 } { recurse => 1 }
@ -39,7 +39,29 @@ $documentation_path->visit(
return; return;
} }
$modules{ $path =~ s{^.*/lib/}{}r =~ s/\.pm\.html$//r =~ s{/}{::}gr } = $modules{ $path =~ s{^.*/lib/}{}r =~ s/\.pm\.html$//r =~ s{/}{::}gr } =
''.$path=~s/doc\///r; $path
},
{ recurse => 1 },
);
$documentation_path->visit(
sub {
my ( $path, $state ) = @_;
if ( !-f $path ) {
return;
}
if ( $path !~ /\.pm\.html$/ ) {
return;
}
my $html = Mojo::DOM->new($path->slurp_utf8);
for my $a ($html->find('a')->each) {
next if $a->{href};
if (exists $modules{$a->text}) {
$a->{href} = relativize_path($path, $modules{$a->text});
next;
}
$a->{href} = "https://metacpan.org/pod/@{[$a->text]}";
}
$path->spew_utf8(''.$html);
}, },
{ recurse => 1 }, { recurse => 1 },
); );
@ -47,6 +69,7 @@ $documentation_path->visit(
my $mojo_template = Mojo::Template->new; my $mojo_template = Mojo::Template->new;
my $html = $mojo_template->render(<<'EOF', \%modules); my $html = $mojo_template->render(<<'EOF', \%modules);
% my ($modules) = @_; % my ($modules) = @_;
% use Path::Tiny;
<html> <html>
<head> <head>
</head> </head>
@ -56,7 +79,7 @@ my $html = $mojo_template->render(<<'EOF', \%modules);
<ul> <ul>
% for my $module (sort { $a cmp $b } keys %$modules) { % for my $module (sort { $a cmp $b } keys %$modules) {
<li> <li>
<a href="<%=$modules->{$module}%>"><%=$module%></a> <a href="<%=path($modules->{$module})->relative('doc')%>"><%=$module%></a>
</li> </li>
% } % }
</ul> </ul>
@ -65,3 +88,9 @@ my $html = $mojo_template->render(<<'EOF', \%modules);
EOF EOF
$documentation_path->child('index.html')->spew_utf8($html); $documentation_path->child('index.html')->spew_utf8($html);
sub relativize_path {
my $current_path = $_[0];
my $foreign_path = $_[1];
return $foreign_path->relative($current_path->parent);
}

4
doc/lib/Peace.pm.html
View File

@ -3,8 +3,8 @@
<html xmlns="http://www.w3.org/1999/xhtml"> <html xmlns="http://www.w3.org/1999/xhtml">
<head> <head>
<title>Peace - Onlie GNU/Linux flatpak apps store.</title> <title>Peace - Onlie GNU/Linux flatpak apps store.</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" /> <meta content="text/html; charset=utf-8" http-equiv="content-type" />
<link rev="made" href="mailto:Alpine@build-edge-aarch64.nonet" /> <link href="mailto:Alpine@build-edge-aarch64.nonet" rev="made" />
</head> </head>
<body> <body>

6
doc/lib/Peace/Controller/User.pm.html
View File

@ -2,9 +2,9 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"> <html xmlns="http://www.w3.org/1999/xhtml">
<head> <head>
<title></title> <title />
<meta http-equiv="content-type" content="text/html; charset=utf-8" /> <meta content="text/html; charset=utf-8" http-equiv="content-type" />
<link rev="made" href="mailto:Alpine@build-edge-aarch64.nonet" /> <link href="mailto:Alpine@build-edge-aarch64.nonet" rev="made" />
</head> </head>
<body> <body>

6
doc/lib/Peace/DAO/Application.pm.html
View File

@ -2,9 +2,9 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"> <html xmlns="http://www.w3.org/1999/xhtml">
<head> <head>
<title></title> <title />
<meta http-equiv="content-type" content="text/html; charset=utf-8" /> <meta content="text/html; charset=utf-8" http-equiv="content-type" />
<link rev="made" href="mailto:Alpine@build-edge-aarch64.nonet" /> <link href="mailto:Alpine@build-edge-aarch64.nonet" rev="made" />
</head> </head>
<body> <body>

6
doc/lib/Peace/DAO/Customer.pm.html
View File

@ -2,9 +2,9 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"> <html xmlns="http://www.w3.org/1999/xhtml">
<head> <head>
<title></title> <title />
<meta http-equiv="content-type" content="text/html; charset=utf-8" /> <meta content="text/html; charset=utf-8" http-equiv="content-type" />
<link rev="made" href="mailto:Alpine@build-edge-aarch64.nonet" /> <link href="mailto:Alpine@build-edge-aarch64.nonet" rev="made" />
</head> </head>
<body> <body>

6
doc/lib/Peace/DAO/Developer.pm.html
View File

@ -2,9 +2,9 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"> <html xmlns="http://www.w3.org/1999/xhtml">
<head> <head>
<title></title> <title />
<meta http-equiv="content-type" content="text/html; charset=utf-8" /> <meta content="text/html; charset=utf-8" http-equiv="content-type" />
<link rev="made" href="mailto:Alpine@build-edge-aarch64.nonet" /> <link href="mailto:Alpine@build-edge-aarch64.nonet" rev="made" />
</head> </head>
<body> <body>

6
doc/lib/Peace/DB.pm.html
View File

@ -3,8 +3,8 @@
<html xmlns="http://www.w3.org/1999/xhtml"> <html xmlns="http://www.w3.org/1999/xhtml">
<head> <head>
<title>Peace::DB - Database handler generator for the Peace shop.</title> <title>Peace::DB - Database handler generator for the Peace shop.</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" /> <meta content="text/html; charset=utf-8" http-equiv="content-type" />
<link rev="made" href="mailto:Alpine@build-edge-aarch64.nonet" /> <link href="mailto:Alpine@build-edge-aarch64.nonet" rev="made" />
</head> </head>
<body> <body>
@ -62,7 +62,7 @@ my $dbh = Peace::DB-&gt;dbh( config =&gt; $config );</code></pre>
<h1 id="SEE-ALSO">SEE ALSO</h1> <h1 id="SEE-ALSO">SEE ALSO</h1>
<p><a>DBI</a>, <a>DBD::Pg</a>, <a href="/lib/Peace.html">Peace</a></p> <p><a href="https://metacpan.org/pod/DBI">DBI</a>, <a href="https://metacpan.org/pod/DBD::Pg">DBD::Pg</a>, <a href="../Peace.pm.html">Peace</a></p>
</body> </body>

8
doc/lib/Peace/Model/Application.pm.html
View File

@ -3,8 +3,8 @@
<html xmlns="http://www.w3.org/1999/xhtml"> <html xmlns="http://www.w3.org/1999/xhtml">
<head> <head>
<title>Peace::Model::Application - The application object representation.</title> <title>Peace::Model::Application - The application object representation.</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" /> <meta content="text/html; charset=utf-8" http-equiv="content-type" />
<link rev="made" href="mailto:Alpine@build-edge-aarch64.nonet" /> <link href="mailto:Alpine@build-edge-aarch64.nonet" rev="made" />
</head> </head>
<body> <body>
@ -129,7 +129,7 @@ $application-&gt;url($url);</code></pre>
$application-&gt;developer($developer);</code></pre> $application-&gt;developer($developer);</code></pre>
<p>Allows to retrieve and set the application&#39;s developer which is a <a>Peace::Model::Developer</a>.</p> <p>Allows to retrieve and set the application&#39;s developer which is a <a href="Developer.pm.html">Peace::Model::Developer</a>.</p>
<h2 id="price">price</h2> <h2 id="price">price</h2>
@ -165,7 +165,7 @@ $application-&gt;verified($verified);</code></pre>
<h1 id="SEE-ALSO">SEE ALSO</h1> <h1 id="SEE-ALSO">SEE ALSO</h1>
<p><a>Peace::Model::Developer</a>, <a>Peace::DAO::Application</a></p> <p><a href="Developer.pm.html">Peace::Model::Developer</a>, <a href="../DAO/Application.pm.html">Peace::DAO::Application</a></p>
</body> </body>

6
doc/lib/Peace/Model/Customer.pm.html
View File

@ -3,8 +3,8 @@
<html xmlns="http://www.w3.org/1999/xhtml"> <html xmlns="http://www.w3.org/1999/xhtml">
<head> <head>
<title>Peace::Model::Customer - The customer object representation.</title> <title>Peace::Model::Customer - The customer object representation.</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" /> <meta content="text/html; charset=utf-8" http-equiv="content-type" />
<link rev="made" href="mailto:Alpine@build-edge-aarch64.nonet" /> <link href="mailto:Alpine@build-edge-aarch64.nonet" rev="made" />
</head> </head>
<body> <body>
@ -96,7 +96,7 @@ $customer-&gt;stripe_id($stripe_id);</code></pre>
<h1 id="SEE-ALSO">SEE ALSO</h1> <h1 id="SEE-ALSO">SEE ALSO</h1>
<p><a>Peace::DAO::Customer</a></p> <p><a href="../DAO/Customer.pm.html">Peace::DAO::Customer</a></p>
</body> </body>

8
doc/lib/Peace/Model/Developer.pm.html
View File

@ -3,8 +3,8 @@
<html xmlns="http://www.w3.org/1999/xhtml"> <html xmlns="http://www.w3.org/1999/xhtml">
<head> <head>
<title>Peace::Model::Developer - The developer object representation.</title> <title>Peace::Model::Developer - The developer object representation.</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" /> <meta content="text/html; charset=utf-8" http-equiv="content-type" />
<link rev="made" href="mailto:Alpine@build-edge-aarch64.nonet" /> <link href="mailto:Alpine@build-edge-aarch64.nonet" rev="made" />
</head> </head>
<body> <body>
@ -83,7 +83,7 @@
<pre><code>my $applications = $developer-&gt;applications;</code></pre> <pre><code>my $applications = $developer-&gt;applications;</code></pre>
<p>Allows to retrieve the developer&#39;s applications which is a arrayref of <a>Peace::Model::Application</a>.</p> <p>Allows to retrieve the developer&#39;s applications which is a arrayref of <a href="Application.pm.html">Peace::Model::Application</a>.</p>
<h2 id="uuid">uuid</h2> <h2 id="uuid">uuid</h2>
@ -157,7 +157,7 @@ $developer-&gt;verified($verified);</code></pre>
<h1 id="SEE-ALSO">SEE ALSO</h1> <h1 id="SEE-ALSO">SEE ALSO</h1>
<p><a>Peace::DAO::Developer</a>, <a>Peace::Model::Application</a></p> <p><a href="../DAO/Developer.pm.html">Peace::DAO::Developer</a>, <a href="Application.pm.html">Peace::Model::Application</a></p>
</body> </body>