From 7be2a2d5f4078ba97b3281f2b5c33ae9bd337be5 Mon Sep 17 00:00:00 2001 From: VirtualTam Date: Fri, 18 Jan 2019 22:36:13 +0100 Subject: 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 --- Makefile | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'Makefile') 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/ -- cgit v1.2.3 From 9eb6055abb2643a9d666b0355cd6d6d67ee4e0ba Mon Sep 17 00:00:00 2001 From: VirtualTam Date: Fri, 18 Jan 2019 22:44:21 +0100 Subject: doc: remove Doxygen configuration Signed-off-by: VirtualTam --- Makefile | 5 ----- 1 file changed, 5 deletions(-) (limited to 'Makefile') diff --git a/Makefile b/Makefile index b13d0561..286d2c90 100644 --- a/Makefile +++ b/Makefile @@ -146,11 +146,6 @@ authors: @git shortlog -sne > AUTHORS @rm .mailmap -### generate Doxygen documentation -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 -- cgit v1.2.3