aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKlaus Weidenbach <Klaus.Weidenbach@gmx.net>2019-01-12 18:33:18 +0100
committerKlaus Weidenbach <Klaus.Weidenbach@gmx.net>2019-01-24 22:03:15 +0100
commit4cc98874a06c2b243d39d1d5e0ea4a44518d50e9 (patch)
treeaa81605a2e034d7032db38ebbf3608f06e1a9d8c
parent1d314834a4d2c1a31c6eedf9889aec2ba07cc47e (diff)
downloadvolse-hubzilla-4cc98874a06c2b243d39d1d5e0ea4a44518d50e9.tar.gz
volse-hubzilla-4cc98874a06c2b243d39d1d5e0ea4a44518d50e9.tar.bz2
volse-hubzilla-4cc98874a06c2b243d39d1d5e0ea4a44518d50e9.zip
Publish doxygen API documentation at gitlab pages.
Create the API documentation with Doxygen and publish it through gitlab-ci as a Gitlab page at: https://hubzilla.frama.io/core This should only happen when master gets updated. Update Doxyfile configuration. Correct image usage. Replace RedMatrix with Hubzilla icon.
-rw-r--r--.gitlab-ci.yml26
-rw-r--r--util/Doxyfile4
2 files changed, 29 insertions, 1 deletions
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index d162d57ba..bf03c1763 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -1,6 +1,10 @@
# Select image from https://hub.docker.com/_/php/
image: php:7.1
+stages:
+ - test
+ - deploy
+
# Select what we should cache
cache:
paths:
@@ -31,6 +35,7 @@ before_script:
# We test PHP7 with MySQL
test:php:mysql:
+ stage: test
services:
- mysql:5.7
script:
@@ -41,6 +46,7 @@ test:php:mysql:
# test PHP7 with PostgreSQL
test:php:postgres:
+ stage: test
services:
- postgres:latest
variables:
@@ -67,3 +73,23 @@ test:php:postgres:
name: "$CI_COMMIT_REF_SLUG-$CI_JOB_NAME"
paths:
- tests/results/
+
+
+# Generate Doxygen API Documentation and deploy it at GitLab pages
+pages:
+ stage: deploy
+ cache: {}
+ image: php:7-cli-alpine
+ before_script:
+ - apk update
+ - apk add doxygen ttf-freefont graphviz
+ script:
+ - doxygen util/Doxyfile
+ - mv doc/html/ public/
+ - echo "API documentation should be accessible at https://hubzilla.frama.io/core/ soon"
+ artifacts:
+ paths:
+ - public
+ only:
+ # Only generate it on main repo's master branch
+ - master@hubzilla/core
diff --git a/util/Doxyfile b/util/Doxyfile
index 7be774a81..14464df81 100644
--- a/util/Doxyfile
+++ b/util/Doxyfile
@@ -1,7 +1,8 @@
INPUT = README.md index.php boot.php include/ install/ util/ view/ Zotlabs/
RECURSIVE = YES
PROJECT_NAME = "The Hubzilla"
-PROJECT_LOGO = images/rm-64.png
+PROJECT_LOGO = images/hz-64.png
+IMAGE_PATH = images/
EXCLUDE = .htconfig.php library/ doc/ store/ vendor/ .git/ util/zotsh/easywebdav/ util/generate-hooks-index/
EXCLUDE_PATTERNS = *smarty3* *strings.php *.out *test*
OUTPUT_DIRECTORY = doc
@@ -33,5 +34,6 @@ INTERACTIVE_SVG = YES
CLASS_GRAPH = YES
COLLABORATION_GRAPH = NO
# fix @var (https://bugzilla.gnome.org/show_bug.cgi?id=626105)
+# Should be obsolete with doxygen >= 1.8.15
#INPUT_FILTER = "sed -e 's/@var\s/@see /'"
INPUT_FILTER = "php util/Doxygen_phpvarfilter.php"