aboutsummaryrefslogtreecommitdiffstats
path: root/build/sami-checkout.conf.php
diff options
context:
space:
mode:
authorAndreas Fischer <bantu@phpbb.com>2014-11-12 21:26:35 +0100
committerAndreas Fischer <bantu@phpbb.com>2014-11-12 21:40:26 +0100
commitb55d744e775d548f451384422d9954309a2bc4b5 (patch)
treebd2e96f95be149d7cbca79ebc426eb8a299acc20 /build/sami-checkout.conf.php
parent6949f64d28290e258719e81cece5443bf977fe9b (diff)
downloadforums-b55d744e775d548f451384422d9954309a2bc4b5.tar
forums-b55d744e775d548f451384422d9954309a2bc4b5.tar.gz
forums-b55d744e775d548f451384422d9954309a2bc4b5.tar.bz2
forums-b55d744e775d548f451384422d9954309a2bc4b5.tar.xz
forums-b55d744e775d548f451384422d9954309a2bc4b5.zip
[ticket/13331] Use docs target for this branch, add docs-all for dev branches.
PHPBB3-13331
Diffstat (limited to 'build/sami-checkout.conf.php')
-rw-r--r--build/sami-checkout.conf.php44
1 files changed, 44 insertions, 0 deletions
diff --git a/build/sami-checkout.conf.php b/build/sami-checkout.conf.php
new file mode 100644
index 0000000000..abbf1d257e
--- /dev/null
+++ b/build/sami-checkout.conf.php
@@ -0,0 +1,44 @@
+<?php
+/**
+*
+* This file is part of the phpBB Forum Software package.
+*
+* @copyright (c) phpBB Limited <https://www.phpbb.com>
+* @license GNU General Public License, version 2 (GPL-2.0)
+*
+* For full copyright and license information, please see
+* the docs/CREDITS.txt file.
+*
+*/
+
+// Prevent 'Class "acm" does not exist.' exception on removeClass().
+class PhpbbArrayStore extends Sami\Store\ArrayStore
+{
+ public function removeClass(Sami\Project $project, $name)
+ {
+ unset($this->classes[$name]);
+ }
+}
+
+$iterator = Symfony\Component\Finder\Finder::create()
+ ->files()
+ ->name('*.php')
+ ->in(__DIR__ . '/../phpBB/')
+ ->notPath('#^cache/#')
+ ->notPath('#^develop/#')
+ ->notPath('#^ext/#')
+ ->notPath('#^vendor/#')
+ ->notPath('data')
+;
+
+$config = array(
+ 'theme' => 'enhanced',
+ 'title' => 'phpBB API Documentation',
+ 'build_dir' => __DIR__.'/api/output/%version%',
+ 'cache_dir' => __DIR__.'/api/cache/%version%',
+ 'default_opened_level' => 2,
+ // Do not use JsonStore. See https://github.com/fabpot/Sami/issues/79
+ 'store' => new PhpbbArrayStore,
+);
+
+return new Sami\Sami($iterator, $config);