2016-01-21 60 views
16

我需要爲PhpDocumentor創建自定義模板。問題是在template.xml中定義的路徑,即使指定爲絕對路徑,也無法正確解析。 PhpDocumentor在vendor目錄中查找它們。Phpdocumentor在供應商目錄中查找自定義模板

<template> 
    <author>Code Mine</author> 
    <email>[email protected]</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設置所有的配置細節。

+0

首先,你的問題是什麼?其次,發佈一些代碼。 – Fin

+0

@Fin我的問題是如何強制documentor從特定位置獲取模板,而不是來自供應商目錄,所涉及的所有代碼都是帶有此配置的xml。 – Adam

回答

1

它將(一些奇怪的原因) 複製將整個模板與原始模板一起放入供應商文件夾,因此template.xml中的路徑結構需要保持不變。你只需要改變例如。 templates/clean/templates/yourtemplatename/

雖然我有一個緩存問題。我無法每次重新讀取我的模板。它將它緩存在某個地方,我不能在我的生活中找出它的位置。文檔非常糟糕,來源更糟糕。

更新: 最後發現它將我的模板緩存在我的電腦的臨時文件夾中。對於Windows例如:c:\Users\<username>\AppData\Local\Temp\phpdoc-twig-cache\。所以我只是刪除整個文件夾。

0

糾正我,如果我錯了,但似乎你可以通過在命令行

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="..."指定自定義模板Ø退了出來,像這樣

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

與幾個..的供應商目錄,或者通過絕對路徑

+0

我現在沒有可能對此進行測試,但我一定會在明天早上做。從我記得,雖然模板路徑查找正確,問題是在模板中定義的路徑。 但正如我所說,我會盡快測試它。 – Adam

+0

老實說,我還沒有能力測試這個......這就是我隱約記得的一段時間,結合鏈接中的文檔 – edhurtig