diff options
| -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 | ||||
| -rw-r--r-- | phpBB/composer.lock | 40 | 
4 files changed, 69 insertions, 42 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); diff --git a/phpBB/composer.lock b/phpBB/composer.lock index 4dd6da46ed..becb7b5f83 100644 --- a/phpBB/composer.lock +++ b/phpBB/composer.lock @@ -10,21 +10,21 @@      "packages-dev": [          {              "name": "fabpot/goutte", -            "version": "v1.0.3", +            "version": "v1.0.7",              "source": {                  "type": "git", -                "url": "https://github.com/fabpot/Goutte.git", -                "reference": "75c9f23c4122caf4ea3e87a42a00b471366e707f" +                "url": "https://github.com/FriendsOfPHP/Goutte.git", +                "reference": "794b196e76bdd37b5155cdecbad311f0a3b07625"              },              "dist": {                  "type": "zip", -                "url": "https://api.github.com/repos/fabpot/Goutte/zipball/75c9f23c4122caf4ea3e87a42a00b471366e707f", -                "reference": "75c9f23c4122caf4ea3e87a42a00b471366e707f", +                "url": "https://api.github.com/repos/FriendsOfPHP/Goutte/zipball/794b196e76bdd37b5155cdecbad311f0a3b07625", +                "reference": "794b196e76bdd37b5155cdecbad311f0a3b07625",                  "shasum": ""              },              "require": {                  "ext-curl": "*", -                "guzzle/http": ">=3.0.5,<3.8-dev", +                "guzzle/http": "~3.1",                  "php": ">=5.3.0",                  "symfony/browser-kit": "~2.1",                  "symfony/css-selector": "~2.1", @@ -33,8 +33,8 @@                  "symfony/process": "~2.1"              },              "require-dev": { -                "guzzle/plugin-history": ">=3.0.5,<3.8-dev", -                "guzzle/plugin-mock": ">=3.0.5,<3.8-dev" +                "guzzle/plugin-history": "~3.1", +                "guzzle/plugin-mock": "~3.1"              },              "type": "application",              "extra": { @@ -54,9 +54,7 @@              "authors": [                  {                      "name": "Fabien Potencier", -                    "email": "fabien@symfony.com", -                    "homepage": "http://fabien.potencier.org", -                    "role": "Lead Developer" +                    "email": "fabien@symfony.com"                  }              ],              "description": "A simple PHP Web Scraper", @@ -64,7 +62,7 @@              "keywords": [                  "scraper"              ], -            "time": "2013-08-16 06:03:22" +            "time": "2014-10-09 15:52:51"          },          {              "name": "guzzle/common", @@ -899,16 +897,16 @@          },          {              "name": "sami/sami", -            "version": "v1.3", +            "version": "v1.4",              "source": {                  "type": "git", -                "url": "https://github.com/fabpot/Sami.git", -                "reference": "76f2ed80b3420f7e2f6dcd5b7218b5a5781f4110" +                "url": "https://github.com/FriendsOfPHP/Sami.git", +                "reference": "70f29c781f7bef30181c814b9471b2ceac694454"              },              "dist": {                  "type": "zip", -                "url": "https://api.github.com/repos/fabpot/Sami/zipball/76f2ed80b3420f7e2f6dcd5b7218b5a5781f4110", -                "reference": "76f2ed80b3420f7e2f6dcd5b7218b5a5781f4110", +                "url": "https://api.github.com/repos/FriendsOfPHP/Sami/zipball/70f29c781f7bef30181c814b9471b2ceac694454", +                "reference": "70f29c781f7bef30181c814b9471b2ceac694454",                  "shasum": ""              },              "require": { @@ -929,7 +927,7 @@              "type": "application",              "extra": {                  "branch-alias": { -                    "dev-master": "1.3-dev" +                    "dev-master": "1.4-dev"                  }              },              "autoload": { @@ -944,9 +942,7 @@              "authors": [                  {                      "name": "Fabien Potencier", -                    "email": "fabien@symfony.com", -                    "homepage": "http://fabien.potencier.org", -                    "role": "Lead Developer" +                    "email": "fabien@symfony.com"                  }              ],              "description": "Sami, an API documentation generator", @@ -954,7 +950,7 @@              "keywords": [                  "phpdoc"              ], -            "time": "2013-11-30 17:16:25" +            "time": "2014-06-25 11:24:03"          },          {              "name": "sebastian/comparator", | 
