Skip to content

Latest commit

 

History

History
11 lines (7 loc) · 510 Bytes

README.md

File metadata and controls

11 lines (7 loc) · 510 Bytes

apiDoc

Docker image for apiDoc.

apiDoc creates a documentation from API annotations in your source code. Official documentation is here.

Basic usage

docker run --rm -v /path/to/your/project/:/input -v /path/for/apidoc/output/:/output ilyachase/apidoc -i /input -o /output -v

Also you will probably want to exclude vendor directory:

docker run --rm -v /path/to/your/project/:/input -v /path/for/apidoc/output/:/output ilyachase/apidoc -i /input -o /output -e /input/vendor -v