Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

phpdoc and phpdoc.dist.xml #3268

Closed
rino1 opened this issue Jul 13, 2022 · 2 comments · Fixed by #3285
Closed

phpdoc and phpdoc.dist.xml #3268

rino1 opened this issue Jul 13, 2022 · 2 comments · Fixed by #3285

Comments

@rino1
Copy link

rino1 commented Jul 13, 2022

$ cat phpdoc.dist.xml
<?xml version="1.0" encoding="UTF-8" ?>
<phpdocumentor
        configVersion="3"
        xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
        xmlns=https://www.phpdoc.org/

xsi:noNamespaceSchemaLocation=https://docs.phpdoc.org/latest/phpdoc.xsd
>
    <paths>
        <output>build/api</output>
        <cache>build/cache</cache>
    </paths>
    <version number="3.0.0">
        <api>
            <source dsn=".">
                <path>src</path>
            </source>
        </api>
    </version>
</phpdocumentor>

$ docker run --rm -v ${PWD}:/data phpdoc/phpdoc:3
Description:
  Parses and transforms the given files to a specified location

Usage:
  project:run [options]
  run
...

Why not work (only show help)?

@phpdoc-bot phpdoc-bot added this to Needs triage in phpDoc issue triage board Jul 13, 2022
@rino1
Copy link
Author

rino1 commented Jul 14, 2022

nothing?

@mvriel
Copy link
Member

mvriel commented Jul 22, 2022

I just checked it out and in the Dockerfile we run the help command by default; but this interferes in your, valid, use case. I have just issued a PR to remove the default CMD line in our dockerfile. That should fix the issue. As a workaround you can run it using the following:

docker run --rm -v ${PWD}:/data phpdoc/phpdoc:3 -v

The -v will override the default CMD (you can actually use anything there) and then it will pick up on your config file.

Thanks for reporting this and please track #3285 to see when it lands :)

@mvriel mvriel closed this as completed Jul 22, 2022
phpDoc issue triage board automation moved this from Needs triage to Closed Jul 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging a pull request may close this issue.

2 participants