2016-01-21 14 views
16

Tôi cần tạo mẫu tùy chỉnh cho PhpDocumentor. Vấn đề là đường dẫn được xác định trong template.xml, ngay cả khi được chỉ định là những đường dẫn tuyệt đối, không được giải quyết chính xác. PhpDocumentor tìm kiếm chúng trong thư mục nhà cung cấp.Phpdocumentor tìm kiếm các mẫu tùy chỉnh trong thư mục nhà cung cấp

<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> 

Mặc dù thực tế rằng các mẫu ghép nằm trong đường dẫn đến xml, tôi nhận được lỗi rằng tệp không tồn tại.

EDIT:

Tôi cũng đã thử với thiết lập tất cả các chi tiết cấu hình trong phpdoc.xml trong hy vọng rằng con đường sẽ được xem xét liên quan đến tập tin cấu hình nhưng không có may mắn.

+0

Đầu tiên, câu hỏi của bạn là gì? Thứ hai, đăng một số mã. – Fin

+0

@Fin câu hỏi của tôi là làm thế nào để lực lượng tài liệu để có được các mẫu từ địa điểm cụ thể, không phải từ các nhà cung cấp dir, tất cả các mã có liên quan là xml này với cấu hình. – Adam

Trả lời

1

Nếu bạn chỉ định một mẫu tuỳ chỉnh với --template="..." nó sẽ (vì một lý do lạ) sao chép toàn bộ mẫu đó vào thư mục của nhà cung cấp cùng với các mẫu gốc và do đó cấu trúc đường dẫn trong template.xml cần giữ nguyên. Bạn chỉ cần thay đổi ví dụ. templates/clean/ đến templates/yourtemplatename/.

Tôi gặp sự cố với bộ nhớ đệm. Tôi không thể làm cho nó đọc lại mẫu của tôi mỗi lần. Nó đã lưu trữ nó ở đâu đó và tôi không thể cho cuộc sống của tôi tìm ra nơi. Tài liệu thực sự là xấu và nguồn là tồi tệ hơn.

Cập nhật: Cuối cùng đã tìm ra rằng nó đã lưu vào mẫu của tôi trong thư mục tạm thời của máy tính của tôi. Đối với Windows ví dụ: c:\Users\<username>\AppData\Local\Temp\phpdoc-twig-cache\. Vì vậy, tôi chỉ xóa toàn bộ thư mục đó.

0

Đúng tôi nếu tôi sai, nhưng nó có vẻ như bạn chỉ có thể vượt qua một đường dẫn tập tin trên CLI

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

Sử dụng một mẫu tùy chỉnh Khi bạn có một công ty hoặc mẫu dự án mang thương hiệu bạn cũng có thể sử dụng với phpDocumentor bằng cách cung cấp vị trí của thư mục của mẫu của bạn:

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

bạn có thể cần t o trở lại ra khỏi thư mục nhà cung cấp với một vài .. 's như vậy

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

hoặc vượt qua một đường dẫn tuyệt đối

+0

Tôi không có khả năng kiểm tra điều này ngay bây giờ nhưng tôi chắc chắn sẽ làm điều đó vào sáng mai. Từ những gì tôi nhớ mặc dù, đường dẫn mẫu được tra cứu chính xác, vấn đề là với đường dẫn được xác định trong mẫu. Nhưng như tôi đã nói, tôi sẽ kiểm tra nó càng sớm càng tốt. – Adam

+0

Tôi thực sự không có khả năng kiểm tra điều này ... đó là những gì tôi mơ hồ nhớ từ một thời gian trở lại kết hợp với các tài liệu trong liên kết – edhurtig

Các vấn đề liên quan