Code Monkey home page Code Monkey logo

phpdoc-docker-image's Introduction

phpDocumentor Docker Image

Build Status Docker Pulls

Status

PROJECT IS CLOSED AND ARCHIVED. NO MAINTAINING WILL BE CONTINUED.

phpDocumentor v3.0.0 is here

Consider to use official phpdoc/phpdoc Docker image instead (source repo).

Supported tags and respective Dockerfile links

What is phpDocumentor?

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

phpDocumentor 2 Logo

manual.phpdoc.org (phpDocumentor 1)
pear.php.net/package/PhpDocumentor

phpDocumentor 1 Logo

How to use this image

Just map your working directory to /app inside container:

docker run --rm -v $(pwd):/app instrumentisto/phpdoc

If 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 --help

License

phpDocumentor 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.

Issues

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.

phpdoc-docker-image's People

Contributors

tyranron avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

phpdoc-docker-image's Issues

docker-compose usage exits

Tried to use this container with docker-compose, inside a yml file, but it keeps exiting as soon as it runs. Is there a way to keep it running?

Also, to access it's interface there is a need to add a port mapping? If yes, this should be done to it's 80 port?

Thank you in advance for your help.

Unable to generate documentation

When I run:

docker run --rm -v $(pwd):/app instrumentisto/phpdoc \
        -f modele/AccesBDD/GestionBDD.php -t ./sortie

Result:

Collecting files .. OK
Initializing parser .. OK
Parsing files
Parsing /app/modele/AccesBDD/GestionBDD.php
Storing cache in "/app/sortie" .. OK
Load cache                                                         ..    0.017s
Preparing template "clean"                                         ..    0.008s
Preparing 17 transformations                                       ..    0.000s
Build "elements" index                                             ..    0.000s
Replace textual FQCNs with object aliases                          ..    0.001s
Resolve @link and @see tags in descriptions                        ..    0.000s
Enriches inline example tags with their sources                    ..    0.000s
Build "packages" index                                             ..    0.000s
Build "namespaces" index and add namespaces to "elements"          ..    0.000s
Collect all markers embedded in tags                               ..    0.000s
Transform analyzed project into artifacts                          ..
Applying 17 transformations
  Initialize writer "phpDocumentor\Plugin\Core\Transformer\Writer\FileIo"
  Initialize writer "phpDocumentor\Plugin\Twig\Writer\Twig"
  Initialize writer "phpDocumentor\Plugin\Graphs\Writer\Graph"
  Execute transformation using writer "FileIo"
  Execute transformation using writer "FileIo"
  Execute transformation using writer "FileIo"
  Execute transformation using writer "FileIo"
  Execute transformation using writer "FileIo"
  Execute transformation using writer "twig"
  Execute transformation using writer "twig"

Warning: file_put_contents(/app/sortie//): failed to open stream: Is a directory in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Plugin/Twig/Writer/Twig.php on line 117
  Execute transformation using writer "twig"

Warning: file_put_contents(/app/sortie//): failed to open stream: Is a directory in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Plugin/Twig/Writer/Twig.php on line 117
  Execute transformation using writer "twig"
  Execute transformation using writer "twig"
  Execute transformation using writer "twig"

Warning: file_put_contents(/app/sortie//): failed to open stream: Is a directory in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Plugin/Twig/Writer/Twig.php on line 117
  Execute transformation using writer "twig"
  Execute transformation using writer "twig"
  Execute transformation using writer "twig"
  Execute transformation using writer "twig"
  Execute transformation using writer "twig"
  Execute transformation using writer "Graph"
   0.448s
Analyze results and write report to log                            ..    0.000s

Directory sortie/files is empty.
Link not work in the page.

docu

I don't know if I miss something into the config or if it's a bug.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.