Refactor phpDoc generation
This commit is contained in:
parent
ff02f34e23
commit
4be51a7bee
10
.gitignore
vendored
10
.gitignore
vendored
|
@ -10,15 +10,17 @@ desktop.ini
|
||||||
.DS_Store
|
.DS_Store
|
||||||
._*
|
._*
|
||||||
|
|
||||||
# Travis
|
|
||||||
/_build/phpdoc-*/
|
|
||||||
/_build/phpdoc-*.git/
|
|
||||||
|
|
||||||
# Composer
|
# Composer
|
||||||
/composer.lock
|
/composer.lock
|
||||||
/composer.phar
|
/composer.phar
|
||||||
/vendor
|
/vendor
|
||||||
|
|
||||||
|
# phpDocumentor
|
||||||
|
/_build/phpdoc/
|
||||||
|
/_build/phpdoc.cache/
|
||||||
|
/_build/phpdoc-*/
|
||||||
|
/_build/phpdoc-*.git/
|
||||||
|
|
||||||
# User config
|
# User config
|
||||||
/config/config.php
|
/config/config.php
|
||||||
|
|
||||||
|
|
39
.phpdoc.xml
39
.phpdoc.xml
|
@ -1,25 +1,32 @@
|
||||||
<?xml version="1.0" encoding="UTF-8" ?>
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||||||
<phpdoc>
|
<phpdoc>
|
||||||
|
<title><![CDATA[Pico 1.0 API Documentation]]></title>
|
||||||
|
<parser>
|
||||||
|
<target>_build/phpdoc.cache</target>
|
||||||
|
</parser>
|
||||||
|
<transformer>
|
||||||
|
<target>_build/phpdoc</target>
|
||||||
|
</transformer>
|
||||||
|
<transformations>
|
||||||
|
<template name="clean"/>
|
||||||
|
</transformations>
|
||||||
<files>
|
<files>
|
||||||
<directory>lib/*</directory>
|
<directory>.</directory>
|
||||||
<file>plugins/DummyPlugin.php</file>
|
<file>index.php</file>
|
||||||
|
<file>index.php.dist</file>
|
||||||
|
|
||||||
|
<!-- exclude build environment -->
|
||||||
<ignore>_build/*</ignore>
|
<ignore>_build/*</ignore>
|
||||||
|
|
||||||
|
<!-- exclude user config -->
|
||||||
<ignore>config/*</ignore>
|
<ignore>config/*</ignore>
|
||||||
<ignore>content-sample/*</ignore>
|
<file>config/config.php.template</file>
|
||||||
<ignore>themes/*</ignore>
|
|
||||||
|
<!-- exclude all plugins -->
|
||||||
<ignore>plugins/*</ignore>
|
<ignore>plugins/*</ignore>
|
||||||
|
<file>plugins/DummyPlugin.php</file>
|
||||||
|
|
||||||
|
<!-- exclude vendor dir -->
|
||||||
<ignore>vendor/*</ignore>
|
<ignore>vendor/*</ignore>
|
||||||
<ignore>.htaccess</ignore>
|
|
||||||
<ignore>*.git</ignore>
|
|
||||||
<ignore>.gitignore</ignore>
|
|
||||||
<ignore>*.xml</ignore>
|
|
||||||
<ignore>*.yml</ignore>
|
|
||||||
<ignore>*.json</ignore>
|
|
||||||
<ignore>*.lock</ignore>
|
|
||||||
<ignore>*.phar</ignore>
|
|
||||||
<ignore>*.md</ignore>
|
|
||||||
<ignore>*LICENSE</ignore>
|
|
||||||
<ignore>index.php</file>
|
|
||||||
<ignore>index.php.dist</ignore>
|
|
||||||
</files>
|
</files>
|
||||||
</phpdoc>
|
</phpdoc>
|
||||||
|
|
|
@ -18,7 +18,9 @@ fi
|
||||||
PHPDOC_ID="${TRAVIS_BRANCH//\//_}"
|
PHPDOC_ID="${TRAVIS_BRANCH//\//_}"
|
||||||
|
|
||||||
generate-phpdoc.sh \
|
generate-phpdoc.sh \
|
||||||
"$TRAVIS_BUILD_DIR" "$TRAVIS_BUILD_DIR/_build/phpdoc-$PHPDOC_ID" \
|
"$TRAVIS_BUILD_DIR/.phpdoc.xml" \
|
||||||
|
"$TRAVIS_BUILD_DIR/_build/phpdoc.cache" \
|
||||||
|
"$TRAVIS_BUILD_DIR/_build/phpdoc-$PHPDOC_ID" \
|
||||||
"Pico 1.0 API Documentation ($TRAVIS_BRANCH branch)"
|
"Pico 1.0 API Documentation ($TRAVIS_BRANCH branch)"
|
||||||
[ $? -eq 0 ] || exit 1
|
[ $? -eq 0 ] || exit 1
|
||||||
|
|
||||||
|
|
|
@ -5,7 +5,9 @@
|
||||||
PHPDOC_ID="${TRAVIS_BRANCH//\//_}"
|
PHPDOC_ID="${TRAVIS_BRANCH//\//_}"
|
||||||
|
|
||||||
generate-phpdoc.sh \
|
generate-phpdoc.sh \
|
||||||
"$TRAVIS_BUILD_DIR" "$TRAVIS_BUILD_DIR/_build/phpdoc-$PHPDOC_ID" \
|
"$TRAVIS_BUILD_DIR/.phpdoc.xml" \
|
||||||
|
"$TRAVIS_BUILD_DIR/_build/phpdoc.cache" \
|
||||||
|
"$TRAVIS_BUILD_DIR/_build/phpdoc-$PHPDOC_ID" \
|
||||||
"Pico 1.0 API Documentation ($TRAVIS_TAG)"
|
"Pico 1.0 API Documentation ($TRAVIS_TAG)"
|
||||||
[ $? -eq 0 ] || exit 1
|
[ $? -eq 0 ] || exit 1
|
||||||
|
|
||||||
|
|
|
@ -2,9 +2,10 @@
|
||||||
set -e
|
set -e
|
||||||
|
|
||||||
# parameters
|
# parameters
|
||||||
PHPDOC_SOURCE_DIR="$1"
|
PHPDOC_CONFIG="$1"
|
||||||
PHPDOC_TARGET_DIR="$2"
|
PHPDOC_CACHE_DIR="$3"
|
||||||
PHPDOC_TITLE="$3"
|
PHPDOC_TARGET_DIR="$4"
|
||||||
|
PHPDOC_TITLE="$5"
|
||||||
|
|
||||||
# print parameters
|
# print parameters
|
||||||
echo "Generating phpDocs..."
|
echo "Generating phpDocs..."
|
||||||
|
@ -14,9 +15,9 @@ printf 'PHPDOC_TITLE="%s"\n' "$PHPDOC_TITLE"
|
||||||
echo
|
echo
|
||||||
|
|
||||||
# generate phpdoc
|
# generate phpdoc
|
||||||
phpdoc -d "$PHPDOC_SOURCE_DIR" \
|
phpdoc --config "$PHPDOC_CONFIG" \
|
||||||
-c "$PHPDOC_SOURCE_DIR/.phpdoc.xml" \
|
--cache-folder "$PHPDOC_CACHE_DIR" \
|
||||||
-t "$PHPDOC_TARGET_DIR" \
|
--target "$PHPDOC_TARGET_DIR" \
|
||||||
--title "$PHPDOC_TITLE"
|
--title "$PHPDOC_TITLE"
|
||||||
|
|
||||||
echo
|
echo
|
||||||
|
|
Loading…
Reference in a new issue