khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-02 09:49:33 +07:00
Code Issues Packages Projects Releases Wiki Activity

Remove server php docs build

Browse Source 
Signed-off-by: Julius Härtl <jus@bitgrid.net>
This commit is contained in:
Julius Härtl
2020-01-18 12:23:05 +01:00
committed by Roeland Jago Douma
parent fe61d0ea4a
commit 823f9668f8
2 changed files with 3 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
Makefile
View File

@@ -18,7 +18,7 @@ user-manual-de-html:
cd user_manual_de && make html
@echo "User manual de build finished; HTML is updated"
developer-manual-html: api-docs icons-docs
developer-manual-html: icons-docs
rm -rf developer_manual/_build/html/com
cd developer_manual && make html
@echo "Developer manual build finished; HTML is updated"
@@ -35,22 +35,13 @@ user-manual-de-pdf:
cd user_manual_de && make latexpdf
@echo "User manual de build finished; PDF is updated"
api-docs: clean-api-docs
cd build && sh get-server-sources.sh $(DRONE_BRANCH)
mkdir -p developer_manual/api/
cd build && composer install && composer update
cd build && php generateApiDoc.php
icons-docs: clean-icons-docs
cd build && sh get-server-sources.sh $(DRONE_BRANCH)
cd build && composer install && composer update
cd build && php generateIconsDoc.php
clean: clean-api-docs clean-icons-docs
rm -r admin_manual/_build developer_manual/_build user_manual/_build user_manual_de_/_build
clean-api-docs:
rm -rf developer_manual/api/
clean: clean-icons-docs
rm -r admin_manual/_build developer_manual/_build user_manual/_build user_manual_de_/_build
clean-icons-docs:
rm -rf developer_manual/design/img/

44
build/generateApiDoc.php
View File

@@ -1,44 +0,0 @@
<?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', 'stable13']);
$apiDocBuilder->build();