From 823f9668f8fe79d02cc11be8d496acfee32fa464 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julius=20H=C3=A4rtl?= Date: Sat, 18 Jan 2020 12:23:05 +0100 Subject: [PATCH] Remove server php docs build MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Julius Härtl --- Makefile | 15 +++----------- build/generateApiDoc.php | 44 ---------------------------------------- 2 files changed, 3 insertions(+), 56 deletions(-) delete mode 100755 build/generateApiDoc.php diff --git a/Makefile b/Makefile index ef026280e..ff97df412 100644 --- a/Makefile +++ b/Makefile @@ -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/ diff --git a/build/generateApiDoc.php b/build/generateApiDoc.php deleted file mode 100755 index f207e5861..000000000 --- a/build/generateApiDoc.php +++ /dev/null @@ -1,44 +0,0 @@ - - * - * @author Julius Härtl - * - * @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 . - * - */ - -/** - * 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(); -