From: VirtualTam <virtualtam@flibidi.net>
Date: Fri, 18 Jan 2019 21:36:13 +0000 (+0100)
Subject: doc: add Make target to run phpDocumentor with Docker
X-Git-Tag: v0.11.0~40^2~1
X-Git-Url: https://git.immae.eu/?p=github%2Fshaarli%2FShaarli.git;a=commitdiff_plain;h=7be2a2d5f4078ba97b3281f2b5c33ae9bd337be5

doc: add Make target to run phpDocumentor with Docker

This target provides a convenient way for running phpDocumentor without
cluttering the system's configuration with PHP extensions, nor the
Composer dependencies.

See:
- https://hub.docker.com/r/phpdoc/phpdoc/dockerfile
- https://github.com/phpDocumentor/phpDocumentor2#via-docker

An alternative is to download the PHAR and run it locally:
- https://docs.phpdoc.org/getting-started/installing.html#phar

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
---

diff --git a/Makefile b/Makefile
index b758d1fd..b13d0561 100644
--- a/Makefile
+++ b/Makefile
@@ -151,6 +151,10 @@ doxygen: clean
 	@rm -rf doxygen
 	@doxygen Doxyfile
 
+### generate phpDocumentor documentation
+phpdoc: clean
+	@docker run --rm -v $(PWD):/data -u `id -u`:`id -g` phpdoc/phpdoc
+
 ### generate HTML documentation from Markdown pages with MkDocs
 htmldoc:
 	python3 -m venv venv/