diff --git a/share/tools/generate_docs.php b/share/tools/generate_docs.php new file mode 100644 index 0000000..6a77033 --- /dev/null +++ b/share/tools/generate_docs.php @@ -0,0 +1,44 @@ + + * @package tools + * @license http://www.opensource.org/licenses/gpl-license.php GNU Public License + * + * This file is part of volkzaehler.org + * + * volkzaehler.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * any later version. + * + * volkzaehler.org 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with volkszaehler.org. If not, see . + */ + +$vzDir = '/var/www/vz'; + +# change directory +chdir($vzDir . '/github/'); + +# update git +passthru('git pull'); + +chdir($vzDir); + +# update dokumentation +passthru('phpdoc/phpdoc --config ' . $vzDir . '/github/share/tools/phpdoc.ini'); + +?> + diff --git a/share/tools/generate_docs.sh b/share/tools/generate_docs.sh deleted file mode 100644 index 929a701..0000000 --- a/share/tools/generate_docs.sh +++ /dev/null @@ -1,35 +0,0 @@ -#!/bin/bash -# -# Copyright (c) 2010 by Justin Otherguy -# -# This program is free software; you can redistribute it and/or modify it -# under the terms of the GNU General Public License (either version 2 or -# version 3) as published by the Free Software Foundation. -# -# 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 General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program; if not, write to the Free Software -# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. -# -# For more information on the GPL, please go to: -# http://www.gnu.org/copyleft/gpl.html -# -# This is simple bash script to update the project documentation -# based on PHPDocumentor. It's used to be invoked by post-commit hooks -# of GitHub or the release script. -# - -# change directory -cd /var/www/vz/github/ - -# update git -git pull - -cd /var/www/vz/ - -# update dokumentation -phpdoc/phpdoc --config /var/www/vz/github/share/tools/phpdoc.ini diff --git a/share/tools/phpdoc.ini b/share/tools/phpdoc.ini index 84f0402..8bd134d 100644 --- a/share/tools/phpdoc.ini +++ b/share/tools/phpdoc.ini @@ -39,7 +39,7 @@ defaultcategoryname = Documentation ;; what is the main package? ;; legal values: alphanumeric string plus - and _ -defaultpackagename = volkszaehler.org +defaultpackagename = default ;; output any parsing information? set to on for cron jobs ;; legal values: on @@ -94,7 +94,7 @@ ignore = .git*,backend/lib/vendor/,backend/lib/Model/Proxies/ ;; HTML:frames:DOM/phphtmllib,HTML:frames:DOM/earthli ;; HTML:Smarty:default,HTML:Smarty:PHP,HTML:Smarty:HandS ;; PDF:default:default,CHM:default:default,XML:DocBook/peardoc2:default -output=HTML:frames:earthli +output=HTML:frames:DOM/earthli ;; turn this option on if you want highlighted source code for every file ;; legal values: on/off