Skip to content

Commit 2bf5472

Browse files
committed
Add DirectoryTree-ImapEngine config
1 parent 97cd7a8 commit 2bf5472

2 files changed

Lines changed: 37 additions & 0 deletions

File tree

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<?php
2+
3+
use Doctum\Doctum;
4+
use Doctum\RemoteRepository\GitHubRemoteRepository;
5+
use Symfony\Component\Finder\Finder;
6+
7+
$rootDir = __DIR__ . '/';
8+
$sourceRootDir = $rootDir . 'sources/DirectoryTree-ImapEngine';
9+
10+
$iterator = Finder::create()
11+
->files()
12+
->name('*.php')
13+
->path('src')
14+
->in($sourceRootDir);
15+
16+
return new Doctum($iterator, [
17+
'title' => 'DirectoryTree/ImapEngine',
18+
'build_dir' => $rootDir . '/DirectoryTree-ImapEngine',
19+
'cache_dir' => $rootDir . '/cache',
20+
'source_dir' => $rootDir,
21+
'version' => 'master',// For remote links to work
22+
'remote_repository' => new GitHubRemoteRepository('DirectoryTree/ImapEngine', $sourceRootDir),
23+
'footer_link' => [
24+
'href' => 'https://github.com/DirectoryTree/ImapEngine#readme',
25+
'rel' => 'noreferrer noopener',
26+
'target' => '_blank',
27+
'before_text' => 'This documentation is built for the',
28+
'link_text' => 'DirectoryTree/ImapEngine',
29+
'after_text' => 'project.',
30+
],
31+
]);

.github/api-docs/index.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,12 @@ <h1 class="display-4">Doctum</h1>
4848
<br>
4949
</div>
5050
</div>
51+
<div class="card">
52+
<div class="card-body text-center">
53+
<a href="https://doctum.long-term.support/api-docs/DirectoryTree-ImapEngine/">DirectoryTree-ImapEngine library</a>
54+
<br>
55+
</div>
56+
</div>
5157
<div class="col-1">&nbsp;</div>
5258
</div>
5359
</div>

0 commit comments

Comments
 (0)