PROJECT IS CLOSED AND ARCHIVED. NO MAINTAINING WILL BE CONTINUED.
Consider to use official phpdoc/phpdoc Docker image instead (source repo).
phpDocumentor 2 is an application that is capable of analyzing your PHP source code and DocBlock comments to generate a complete set of API Documentation.
Inspired by phpDocumentor 1 and JavaDoc it continues to innovate and is up to date with the latest technologies and PHP language features.
www.phpdoc.org (phpDocumentor)
github.com/phpDocumentor/phpDocumentor
manual.phpdoc.org (phpDocumentor 1)
pear.php.net/package/PhpDocumentor
Just map your working directory to /app inside container:
docker run --rm -v $(pwd):/app instrumentisto/phpdocIf you need to specify some options just do so:
docker run --rm -v $(pwd):/app instrumentisto/phpdoc --help
docker run --rm -v $(pwd):/app instrumentisto/phpdoc run -d <SOURCE_DIRECTORY> -t <TARGET_DIRECTORY>If you want to use your vendored phpDocumentor version just change the entrypoint:
docker run --rm -v $(pwd):/app --entrypoint vendor/bin/phpdoc instrumentisto/phpdoc --helpphpDocumentor 2 is licensed under MIT license.
phpDocumentor 1 is licensed under LGPL license.
As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).
As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.
The sources for producing instrumentisto/phpdoc Docker images are licensed under Blue Oak Model License 1.0.0.
We can't notice comments in the DockerHub so don't use them for reporting issue or asking question.
If you have any problems with or questions about this image, please contact us through a GitHub issue.