mirror of
https://github.com/phpbb/phpbb.git
synced 2025-06-08 04:18:52 +00:00
Merge pull request #3142 from bantu/ticket/13331
[ticket/13331] Use docs target for this branch, add docs-all for all branches
This commit is contained in:
Joas Schilling
commit
b99fbd0be0
4 changed files with 69 additions and 42 deletions
|
|
@ -73,9 +73,16 @@
|
||||||
passthru="true" />
|
passthru="true" />
|
||||||
</target>
|
</target>
|
||||||
|
|
||||||
|
<!-- Builds docs for current branch into build/api/output/master -->
|
||||||
<target name="docs">
|
<target name="docs">
|
||||||
<exec dir="."
|
<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" />
|
passthru="true" />
|
||||||
</target>
|
</target>
|
||||||
|
|
||||||
|
|
|
||||||
30
build/sami-all.conf.php
Normal file
30
build/sami-all.conf.php
Normal file
|
|
@ -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);
|
||||||
|
|
@ -1,7 +1,14 @@
|
||||||
<?php
|
<?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().
|
// Prevent 'Class "acm" does not exist.' exception on removeClass().
|
||||||
|
|
@ -24,27 +31,14 @@ $iterator = Symfony\Component\Finder\Finder::create()
|
||||||
->notPath('data')
|
->notPath('data')
|
||||||
;
|
;
|
||||||
|
|
||||||
$versions = Sami\Version\GitVersionCollection::create(__DIR__ . '/../')
|
$config = array(
|
||||||
/*
|
|
||||||
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',
|
'theme' => 'enhanced',
|
||||||
'versions' => $versions,
|
|
||||||
'title' => 'phpBB API Documentation',
|
'title' => 'phpBB API Documentation',
|
||||||
'build_dir' => __DIR__.'/api/output/%version%',
|
'build_dir' => __DIR__.'/api/output/%version%',
|
||||||
'cache_dir' => __DIR__.'/api/cache/%version%',
|
'cache_dir' => __DIR__.'/api/cache/%version%',
|
||||||
'default_opened_level' => 2,
|
'default_opened_level' => 2,
|
||||||
// Do not use JsonStore. See https://github.com/fabpot/Sami/issues/79
|
// Do not use JsonStore. See https://github.com/fabpot/Sami/issues/79
|
||||||
'store' => new PhpbbArrayStore,
|
'store' => new PhpbbArrayStore,
|
||||||
));
|
);
|
||||||
|
|
||||||
|
return new Sami\Sami($iterator, $config);
|
||||||
40
phpBB/composer.lock
generated
40
phpBB/composer.lock
generated
|
|
@ -10,21 +10,21 @@
|
||||||
"packages-dev": [
|
"packages-dev": [
|
||||||
{
|
{
|
||||||
"name": "fabpot/goutte",
|
"name": "fabpot/goutte",
|
||||||
"version": "v1.0.3",
|
"version": "v1.0.7",
|
||||||
"source": {
|
"source": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "https://github.com/fabpot/Goutte.git",
|
"url": "https://github.com/FriendsOfPHP/Goutte.git",
|
||||||
"reference": "75c9f23c4122caf4ea3e87a42a00b471366e707f"
|
"reference": "794b196e76bdd37b5155cdecbad311f0a3b07625"
|
||||||
},
|
},
|
||||||
"dist": {
|
"dist": {
|
||||||
"type": "zip",
|
"type": "zip",
|
||||||
"url": "https://api.github.com/repos/fabpot/Goutte/zipball/75c9f23c4122caf4ea3e87a42a00b471366e707f",
|
"url": "https://api.github.com/repos/FriendsOfPHP/Goutte/zipball/794b196e76bdd37b5155cdecbad311f0a3b07625",
|
||||||
"reference": "75c9f23c4122caf4ea3e87a42a00b471366e707f",
|
"reference": "794b196e76bdd37b5155cdecbad311f0a3b07625",
|
||||||
"shasum": ""
|
"shasum": ""
|
||||||
},
|
},
|
||||||
"require": {
|
"require": {
|
||||||
"ext-curl": "*",
|
"ext-curl": "*",
|
||||||
"guzzle/http": ">=3.0.5,<3.8-dev",
|
"guzzle/http": "~3.1",
|
||||||
"php": ">=5.3.0",
|
"php": ">=5.3.0",
|
||||||
"symfony/browser-kit": "~2.1",
|
"symfony/browser-kit": "~2.1",
|
||||||
"symfony/css-selector": "~2.1",
|
"symfony/css-selector": "~2.1",
|
||||||
|
|
@ -33,8 +33,8 @@
|
||||||
"symfony/process": "~2.1"
|
"symfony/process": "~2.1"
|
||||||
},
|
},
|
||||||
"require-dev": {
|
"require-dev": {
|
||||||
"guzzle/plugin-history": ">=3.0.5,<3.8-dev",
|
"guzzle/plugin-history": "~3.1",
|
||||||
"guzzle/plugin-mock": ">=3.0.5,<3.8-dev"
|
"guzzle/plugin-mock": "~3.1"
|
||||||
},
|
},
|
||||||
"type": "application",
|
"type": "application",
|
||||||
"extra": {
|
"extra": {
|
||||||
|
|
@ -54,9 +54,7 @@
|
||||||
"authors": [
|
"authors": [
|
||||||
{
|
{
|
||||||
"name": "Fabien Potencier",
|
"name": "Fabien Potencier",
|
||||||
"email": "fabien@symfony.com",
|
"email": "fabien@symfony.com"
|
||||||
"homepage": "http://fabien.potencier.org",
|
|
||||||
"role": "Lead Developer"
|
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "A simple PHP Web Scraper",
|
"description": "A simple PHP Web Scraper",
|
||||||
|
|
@ -64,7 +62,7 @@
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"scraper"
|
"scraper"
|
||||||
],
|
],
|
||||||
"time": "2013-08-16 06:03:22"
|
"time": "2014-10-09 15:52:51"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "guzzle/common",
|
"name": "guzzle/common",
|
||||||
|
|
@ -899,16 +897,16 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "sami/sami",
|
"name": "sami/sami",
|
||||||
"version": "v1.3",
|
"version": "v1.4",
|
||||||
"source": {
|
"source": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "https://github.com/fabpot/Sami.git",
|
"url": "https://github.com/FriendsOfPHP/Sami.git",
|
||||||
"reference": "76f2ed80b3420f7e2f6dcd5b7218b5a5781f4110"
|
"reference": "70f29c781f7bef30181c814b9471b2ceac694454"
|
||||||
},
|
},
|
||||||
"dist": {
|
"dist": {
|
||||||
"type": "zip",
|
"type": "zip",
|
||||||
"url": "https://api.github.com/repos/fabpot/Sami/zipball/76f2ed80b3420f7e2f6dcd5b7218b5a5781f4110",
|
"url": "https://api.github.com/repos/FriendsOfPHP/Sami/zipball/70f29c781f7bef30181c814b9471b2ceac694454",
|
||||||
"reference": "76f2ed80b3420f7e2f6dcd5b7218b5a5781f4110",
|
"reference": "70f29c781f7bef30181c814b9471b2ceac694454",
|
||||||
"shasum": ""
|
"shasum": ""
|
||||||
},
|
},
|
||||||
"require": {
|
"require": {
|
||||||
|
|
@ -929,7 +927,7 @@
|
||||||
"type": "application",
|
"type": "application",
|
||||||
"extra": {
|
"extra": {
|
||||||
"branch-alias": {
|
"branch-alias": {
|
||||||
"dev-master": "1.3-dev"
|
"dev-master": "1.4-dev"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"autoload": {
|
"autoload": {
|
||||||
|
|
@ -944,9 +942,7 @@
|
||||||
"authors": [
|
"authors": [
|
||||||
{
|
{
|
||||||
"name": "Fabien Potencier",
|
"name": "Fabien Potencier",
|
||||||
"email": "fabien@symfony.com",
|
"email": "fabien@symfony.com"
|
||||||
"homepage": "http://fabien.potencier.org",
|
|
||||||
"role": "Lead Developer"
|
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "Sami, an API documentation generator",
|
"description": "Sami, an API documentation generator",
|
||||||
|
|
@ -954,7 +950,7 @@
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"phpdoc"
|
"phpdoc"
|
||||||
],
|
],
|
||||||
"time": "2013-11-30 17:16:25"
|
"time": "2014-06-25 11:24:03"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "sebastian/comparator",
|
"name": "sebastian/comparator",
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue