16

我需要为 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>

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

编辑：

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

4

2 回答 2

1

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

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

更新： 终于发现它将我的模板缓存在我电脑的临时文件夹中。对于 Windows，例如：c:\Users\<username>\AppData\Local\Temp\phpdoc-twig-cache\. 所以我只是删除了整个文件夹。

于 2017-09-28T08:42:19.353 回答
0

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

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

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

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

..您可能需要像这样退出 vendor 目录

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

或传递绝对路径

--template="/var/scratch/foo/data/templates/my_template"
于 2016-06-01T06:31:39.510 回答