aboutsummaryrefslogtreecommitdiffstats
path: root/build/sami.conf.php
blob: febd0276d45941cfc16403a6311fe4d531e11ec2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
<?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')
;

$versions = Sami\Version\GitVersionCollection::create(__DIR__ . '/../')
	/*
	This would be nice, but currently causes various problems that need
	debugging.
	->addFromTags('release-3.0.*')
	->add('develop-olympus', '3.0-next (olympus)')
	->addFromTags('release-3.1.*')
	->add('develop-ascraeus', '3.1-next (ascraeus)')
	->add('develop')
	*/
	->add('develop-olympus')
	->add('develop-ascraeus')
;

return new Sami\Sami($iterator, array(
	'theme'                => 'enhanced',
	'versions'             => $versions,
	'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,
));