diff options
| author | Andreas Fischer <bantu@phpbb.com> | 2014-11-12 21:26:35 +0100 |
|---|---|---|
| committer | Andreas Fischer <bantu@phpbb.com> | 2014-11-12 21:40:26 +0100 |
| commit | b55d744e775d548f451384422d9954309a2bc4b5 (patch) | |
| tree | bd2e96f95be149d7cbca79ebc426eb8a299acc20 | |
| parent | 6949f64d28290e258719e81cece5443bf977fe9b (diff) | |
| download | forums-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
| -rw-r--r-- | build/build.xml | 9 | ||||
| -rw-r--r-- | build/sami-all.conf.php | 30 | ||||
| -rw-r--r-- | build/sami-checkout.conf.php (renamed from build/sami.conf.php) | 32 |
3 files changed, 51 insertions, 20 deletions
diff --git a/build/build.xml b/build/build.xml index 6873f48fab..693a1997ae 100644 --- a/build/build.xml +++ b/build/build.xml @@ -73,9 +73,16 @@ passthru="true" /> </target> + <!-- Builds docs for current branch into build/api/output/master --> <target name="docs"> <exec dir="." - command="phpBB/vendor/bin/sami.php update build/sami.conf.php" + command="phpBB/vendor/bin/sami.php update build/sami-checkout.conf.php" + passthru="true" /> + </target> + <!-- Builds docs for multiple branches/tags into build/api/output/$branch --> + <target name="docs-all"> + <exec dir="." + command="phpBB/vendor/bin/sami.php update build/sami-all.conf.php" passthru="true" /> </target> diff --git a/build/sami-all.conf.php b/build/sami-all.conf.php new file mode 100644 index 0000000000..68350fee8f --- /dev/null +++ b/build/sami-all.conf.php @@ -0,0 +1,30 @@ +<?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. +* +*/ + +require __DIR__ . '/sami-checkout.conf.php'; + +$config['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, $config); diff --git a/build/sami.conf.php b/build/sami-checkout.conf.php index dd57ec8780..abbf1d257e 100644 --- a/build/sami.conf.php +++ b/build/sami-checkout.conf.php @@ -1,7 +1,14 @@ <?php /** -* @copyright (c) 2014 phpBB Group -* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2 +* +* 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(). @@ -24,27 +31,14 @@ $iterator = Symfony\Component\Finder\Finder::create() ->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( +$config = 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, -)); +); + +return new Sami\Sami($iterator, $config); |