diff options
| author | Andreas Fischer <bantu@phpbb.com> | 2014-11-12 21:43:56 +0100 |
|---|---|---|
| committer | Andreas Fischer <bantu@phpbb.com> | 2014-11-12 21:43:56 +0100 |
| commit | 01034785213435e7d90523f626694f3a9c71fb79 (patch) | |
| tree | ec35045fe2e815a20bc28fd323e325e3b3dca920 | |
| parent | 09ad1d529ef76358eeb25be38884de61a410d066 (diff) | |
| parent | b55d744e775d548f451384422d9954309a2bc4b5 (diff) | |
| download | forums-01034785213435e7d90523f626694f3a9c71fb79.tar forums-01034785213435e7d90523f626694f3a9c71fb79.tar.gz forums-01034785213435e7d90523f626694f3a9c71fb79.tar.bz2 forums-01034785213435e7d90523f626694f3a9c71fb79.tar.xz forums-01034785213435e7d90523f626694f3a9c71fb79.zip | |
Merge pull request #3142 from bantu/ticket/13331
[ticket/13331] Use docs target for this branch, add docs-all for all branches
* bantu/ticket/13331:
[ticket/13331] Use docs target for this branch, add docs-all for dev branches.
Conflicts:
build/build.xml
build/sami-checkout.conf.php
| -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) | 15 |
3 files changed, 38 insertions, 16 deletions
diff --git a/build/build.xml b/build/build.xml index 124e7dc074..c97d200fbb 100644 --- a/build/build.xml +++ b/build/build.xml @@ -117,9 +117,16 @@ </if> </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 78d532631c..abbf1d257e 100644 --- a/build/sami.conf.php +++ b/build/sami-checkout.conf.php @@ -31,23 +31,8 @@ $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') -; - $config = array( 'theme' => 'enhanced', - 'versions' => $versions, 'title' => 'phpBB API Documentation', 'build_dir' => __DIR__.'/api/output/%version%', 'cache_dir' => __DIR__.'/api/cache/%version%', |