diff options
| author | Andreas Fischer <bantu@phpbb.com> | 2014-05-16 17:54:40 +0200 |
|---|---|---|
| committer | Andreas Fischer <bantu@phpbb.com> | 2014-05-16 17:56:03 +0200 |
| commit | f08f283143823d0bbaad124e487cf57821ea70ab (patch) | |
| tree | 264436214e12527444d6d207fa9bc719f57fc7fe /build/sami.conf.php | |
| parent | b32f91b9c6cf2f8756de4a8ecd5623b8a3c8b0e2 (diff) | |
| download | forums-f08f283143823d0bbaad124e487cf57821ea70ab.tar forums-f08f283143823d0bbaad124e487cf57821ea70ab.tar.gz forums-f08f283143823d0bbaad124e487cf57821ea70ab.tar.bz2 forums-f08f283143823d0bbaad124e487cf57821ea70ab.tar.xz forums-f08f283143823d0bbaad124e487cf57821ea70ab.zip | |
[task/sami] Replace phpdoctor with sami.
PHPBB3-12495
Diffstat (limited to 'build/sami.conf.php')
| -rw-r--r-- | build/sami.conf.php | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/build/sami.conf.php b/build/sami.conf.php new file mode 100644 index 0000000000..0edf918a2d --- /dev/null +++ b/build/sami.conf.php @@ -0,0 +1,49 @@ +<?php +/** +* @copyright (c) 2014 phpBB Group +* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2 +*/ + +// 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('#^vendor/#') + ->notPath('#^develop/#') + ->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, +)); |