From b55d744e775d548f451384422d9954309a2bc4b5 Mon Sep 17 00:00:00 2001
From: Andreas Fischer <bantu@phpbb.com>
Date: Wed, 12 Nov 2014 21:26:35 +0100
Subject: [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 ++++++++++++++++++++++++++
 build/sami-checkout.conf.php | 44 ++++++++++++++++++++++++++++++++++++++
 build/sami.conf.php          | 50 --------------------------------------------
 4 files changed, 82 insertions(+), 51 deletions(-)
 create mode 100644 build/sami-all.conf.php
 create mode 100644 build/sami-checkout.conf.php
 delete mode 100644 build/sami.conf.php

(limited to 'build')

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-checkout.conf.php b/build/sami-checkout.conf.php
new file mode 100644
index 0000000000..abbf1d257e
--- /dev/null
+++ b/build/sami-checkout.conf.php
@@ -0,0 +1,44 @@
+<?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')
+;
+
+$config = array(
+	'theme'                => 'enhanced',
+	'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);
diff --git a/build/sami.conf.php b/build/sami.conf.php
deleted file mode 100644
index dd57ec8780..0000000000
--- a/build/sami.conf.php
+++ /dev/null
@@ -1,50 +0,0 @@
-<?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('#^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,
-));
-- 
cgit v1.2.1