From b55d744e775d548f451384422d9954309a2bc4b5 Mon Sep 17 00:00:00 2001 From: Andreas Fischer Date: Wed, 12 Nov 2014 21:26:35 +0100 Subject: [PATCH 1/2] [ticket/13331] Use docs target for this branch, add docs-all for dev branches. PHPBB3-13331 --- build/build.xml | 9 +++++- build/sami-all.conf.php | 30 +++++++++++++++++ .../{sami.conf.php => sami-checkout.conf.php} | 32 ++++++++----------- 3 files changed, 51 insertions(+), 20 deletions(-) create mode 100644 build/sami-all.conf.php rename build/{sami.conf.php => sami-checkout.conf.php} (58%) 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" /> + + + + + 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 @@ + +* @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 similarity index 58% rename from build/sami.conf.php rename to build/sami-checkout.conf.php index dd57ec8780..abbf1d257e 100644 --- a/build/sami.conf.php +++ b/build/sami-checkout.conf.php @@ -1,7 +1,14 @@ +* @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); From 968360fed6ac614e2271942e0df4a70e66be4738 Mon Sep 17 00:00:00 2001 From: Andreas Fischer Date: Wed, 12 Nov 2014 21:45:03 +0100 Subject: [PATCH 2/2] [ticket/13331] Remove travis/sami.conf.php. Use build/sami-checkout.conf.php. PHPBB3-13331 --- travis/check-sami-parse-errors.sh | 2 +- travis/sami.conf.php | 19 ------------------- 2 files changed, 1 insertion(+), 20 deletions(-) delete mode 100644 travis/sami.conf.php diff --git a/travis/check-sami-parse-errors.sh b/travis/check-sami-parse-errors.sh index 847c54a61a..c3338e34db 100755 --- a/travis/check-sami-parse-errors.sh +++ b/travis/check-sami-parse-errors.sh @@ -20,7 +20,7 @@ then # and # https://github.com/fabpot/Sami/issues/117 errors=$( - unbuffer phpBB/vendor/bin/sami.php parse travis/sami.conf.php -v | \ + unbuffer phpBB/vendor/bin/sami.php parse build/sami-checkout.conf.php -v | \ sed "s,\x1B\[[0-9;]*[a-zA-Z],,g" | \ grep "ERROR: " | \ tee /dev/tty | \ diff --git a/travis/sami.conf.php b/travis/sami.conf.php deleted file mode 100644 index 8e7cfa42e9..0000000000 --- a/travis/sami.conf.php +++ /dev/null @@ -1,19 +0,0 @@ - -* @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__ . '/../build/' . basename(__FILE__); - -// Removing the versions array key will make Sami use the current branch. -unset($config['versions']); - -return new Sami\Sami($iterator, $config);