phpDocumentor: php documentor version 3 is not using configuration file

Expected Behavior

I have a configuration file that defines another target for the parser, another target for the transformer and a template. I expect that it still works or at least the documentation says how to configure this now and what needs to be changed for version 3.

Actual Behavior

It renders the default template to the default path which is useless for me.

Steps to Reproduce the Problem

  1. Create a custom template
  2. Create a configuration file
  3. run phpDocumentor v3 with -c <path-to-config.xml>

Your environment

  • Version used: 3.0.0-alpha.2
  • Install method: downloaded .phar with public key
  • php version 7.2.9
  • Operating system: Manjaro (rolling release)
  • Link to your project: https://github.com/tflori/orm
<?xml version="1.0" encoding="UTF-8" ?>
<phpdoc>
    <parser>
        <target>/tmp/phpdoc/orm</target>
    </parser>
    <transformer>
        <target>docs</target>
    </transformer>
    <transformations>
        <template name="docs/_reference"/>
    </transformations>
    <files>
        <directory>src</directory>
    </files>
</phpdoc>

About this issue

  • Original URL
  • State: closed
  • Created 6 years ago
  • Reactions: 5
  • Comments: 15 (7 by maintainers)

Most upvoted comments

That is indeed the root of my project. Thank you sir, it worked. I thought the source paths where relative to the configuration file. I read that somewhere in the documentation on docs.php.org.

The source path is relative to the director where you start phpdocumentor. With this configuration you should be in the directory sead, I expect that to be the root of your project 😄

The current phar is not working correctly. We need to create a new release to provide a new phar. You could try the install latest version from the develop branch. Using composer.

I have just pushed changes to re-enable the use of an external configuration file. This is on develop and has no phar as of yet.