centersl/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-03-26 13:28:45 +07:00
Code Issues Packages Projects Releases Wiki Activity

Move to build directory

Browse Source 
Signed-off-by: Julius Härtl <jus@bitgrid.net>
This commit is contained in:
Julius Härtl
2017-10-18 14:16:20 +02:00
committed by Morris Jobke
parent 67a61197a0
commit 06086446bf
7 changed files with 38 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
build/composer.json Normal file
View File

@@ -0,0 +1,6 @@
{
"minimum-stability": "dev",
"require": {
"juliushaertl/phpdoc-to-rst": "dev-master"
}
}

44
build/generateApiDoc.php Executable file
View File

@@ -0,0 +1,44 @@
<?php
/**
* @copyright Copyright (c) 2017 Julius Härtl <jus@bitgrid.net>
*
* @author Julius Härtl <jus@bitgrid.net>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
/*
* This is a short example on how you can generate the API documentation for Nextcloud
*/
include __DIR__ . '/vendor/autoload.php';
use JuliusHaertl\PHPDocToRst\ApiDocBuilder;
$nextcloudSource = [
__DIR__ . '/server/lib/public',
__DIR__ . '/server/lib/private',
];
$destinationDirectory = __DIR__ . '/../developer_manual/api';
$apiDocBuilder = new ApiDocBuilder($nextcloudSource, $destinationDirectory);
$apiDocBuilder->setVerboseOutput(true);
$apiDocBuilder->addExtension(\JuliusHaertl\PHPDocToRst\Extension\InterfaceImplementors::class);
$apiDocBuilder->addExtension(\JuliusHaertl\PHPDocToRst\Extension\NoPrivateExtension::class);
$apiDocBuilder->addExtension(\JuliusHaertl\PHPDocToRst\Extension\GithubLocationExtension::class, [__DIR__ . '/server/', 'https://github.com/nextcloud/server']);
$apiDocBuilder->build();

13
build/get-server-sources.sh Executable file
View File

@@ -0,0 +1,13 @@
#!/bin/bash
#
# Clone Nextcloud server repo into $CWD/server
# if it already exists the latest commits from
# the specified branch will be fetched
NC_BRANCH="${1:-master}"
if [ -d server/.git ]; then
cd server && git fetch && git checkout $NC_BRANCH && git reset --hard origin/$NC_BRANCH
else
git clone https://github.com/nextcloud/server server
fi;