diff options
author | VirtualTam <virtualtam@flibidi.net> | 2019-01-18 22:36:13 +0100 |
---|---|---|
committer | VirtualTam <virtualtam@flibidi.net> | 2019-01-18 22:40:15 +0100 |
commit | 7be2a2d5f4078ba97b3281f2b5c33ae9bd337be5 (patch) | |
tree | 67e045792169ba88ee14adba72524d59976daa14 | |
parent | 1c53591a43cfea0c7c7ca0ed4cd223cef842eaf3 (diff) | |
download | Shaarli-7be2a2d5f4078ba97b3281f2b5c33ae9bd337be5.tar.gz Shaarli-7be2a2d5f4078ba97b3281f2b5c33ae9bd337be5.tar.zst Shaarli-7be2a2d5f4078ba97b3281f2b5c33ae9bd337be5.zip |
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>
-rw-r--r-- | Makefile | 4 |
1 files changed, 4 insertions, 0 deletions
@@ -151,6 +151,10 @@ doxygen: clean | |||
151 | @rm -rf doxygen | 151 | @rm -rf doxygen |
152 | @doxygen Doxyfile | 152 | @doxygen Doxyfile |
153 | 153 | ||
154 | ### generate phpDocumentor documentation | ||
155 | phpdoc: clean | ||
156 | @docker run --rm -v $(PWD):/data -u `id -u`:`id -g` phpdoc/phpdoc | ||
157 | |||
154 | ### generate HTML documentation from Markdown pages with MkDocs | 158 | ### generate HTML documentation from Markdown pages with MkDocs |
155 | htmldoc: | 159 | htmldoc: |
156 | python3 -m venv venv/ | 160 | python3 -m venv venv/ |