【问题标题】:Phpdocumentor looks for custom templates in vendor directoryPhpdocumentor 在供应商目录中查找自定义模板
【发布时间】:2016-04-27 12:47:58
【问题描述】:

我需要为 PhpDocumentor 创建自定义模板。问题是template.xml 中定义的路径,即使指定为绝对路径,也无法正确解析。 PhpDocumentor 在供应商目录中查找它们。

<template>
    <author>Code Mine</author>
    <email>office@code-mine.com</email>
    <description>Template for Confluence API</description>
    <version>1.0.0</version>
    <transformations>
        <transformation writer="twig" source="./index.html.twig" artifact="index.html"/>
        <transformation query="indexes.namespaces" writer="twig" source="./namespace.html.twig" />
        <transformation query="indexes.classes" writer="twig" source="./class.html.twig" />
    </transformations>
</template>

尽管 twig 模板位于 xml 引用的路径中,但我收到文件不存在的错误。

编辑:

我还尝试在phpdoc.xml 中设置所有配置详细信息,希望路径将被视为相对于配置文件,但没有运气。

【问题讨论】:

  • 首先,您的问题是什么?其次,贴一些代码。
  • @Fin 我的问题是如何强制 documentor 从特定位置获取模板,而不是从供应商目录中获取模板,所涉及的所有代码都是带有配置的 xml。

标签: php twig phpdoc phpdocumentor2


【解决方案1】:

如果您使用--template="..." 指定自定义模板,它将(出于某种奇怪的原因)复制整个模板与原始模板一起进入供应商文件夹,因此@987654322 中的路径结构@ 需要保持不变。你只需要改变例如。 templates/clean/templates/yourtemplatename/

我有一个缓存问题。我无法让它每次都重新阅读我的模板。它已将其缓存在某个地方,我一生都无法弄清楚在哪里。文档真的很糟糕,来源更糟糕。

更新: 最后发现它把我的模板缓存在我电脑的临时文件夹中。对于 Windows,例如:c:\Users\&lt;username&gt;\AppData\Local\Temp\phpdoc-twig-cache\。所以我只是删除了整个文件夹。

【讨论】:

    【解决方案2】:

    如果我错了,请纠正我,但您似乎可以在 CLI 上传递文件路径

    https://www.phpdoc.org/docs/latest/getting-started/changing-the-look-and-feel.html

    使用自定义模板 当您拥有公司或项目品牌模板时,您还可以通过提供模板文件夹的位置将其与 phpDocumentor 一起使用:

    $ phpdoc -d "./src" -t "./docs/api" --template="data/templates/my_template"
    

    您可能需要使用一些 .. 退出供应商目录

    --template="../../data/templates/my_template"
    

    或者传递一个绝对路径

    --template="/var/scratch/foo/data/templates/my_template"
    

    【讨论】:

    • 我现在无法对此进行测试,但我一定会在明天早上进行。据我记得,模板路径被正确查找,问题在于模板中定义的路径。但正如我所说,我会尽快测试它。
    • 老实说,我也没有能力对此进行测试......这是我前段时间结合链接中的文档模糊记得的内容
    猜你喜欢
    • 1970-01-01
    • 2012-11-13
    • 2018-10-03
    • 1970-01-01
    • 2016-12-22
    • 1970-01-01
    • 2018-12-09
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多