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.
This commit is contained in:
parent
1d314834a4
commit
4cc98874a0
@ -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
|
||||
|
@ -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"
|
||||
|
Reference in New Issue
Block a user