]> git.immae.eu Git - github/shaarli/Shaarli.git/commitdiff
doc: add Make target to run phpDocumentor with Docker
authorVirtualTam <virtualtam@flibidi.net>
Fri, 18 Jan 2019 21:36:13 +0000 (22:36 +0100)
committerVirtualTam <virtualtam@flibidi.net>
Fri, 18 Jan 2019 21:40:15 +0000 (22:40 +0100)
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>
Makefile

index b758d1fd276e91fd523b3b1410c89341a6ed906a..b13d0561318c93296415622f0a2fbb2d03b25d58 100644 (file)
--- 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/