Phpdocumentor busca plantillas personalizadas en el directorio de proveedores

twig phpdocumentor2

Question

Necesito crear una plantilla personalizada para PhpDocumentor. El problema es que las rutas definidas en el template.xml , incluso cuando se especifican como absolutas, no se resuelven correctamente. PhpDocumentor los busca en el directorio de proveedores.

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

A pesar del hecho de que las plantillas de ramitas están ubicadas en la ruta a la que se refiere xml, recibo un error de que los archivos no existen.

EDITAR:

También he intentado configurar todos los detalles de configuración en phpdoc.xml con la esperanza de que las rutas se consideren relativas al archivo de configuración pero sin suerte.

Answer 1

Corríjame si me equivoco, pero parece que solo puede pasar una ruta de archivo en la CLI

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

Uso de una plantilla personalizada Cuando tiene una empresa o una plantilla con marca de proyecto, también puede usar eso con phpDocumentor proporcionando la ubicación de la carpeta de su plantilla:

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

es posible que deba retroceder fuera del directorio de proveedores con unos pocos .. ''s like

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

o pasar un camino absoluto

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

Answer 2

Si especifica una plantilla personalizada con --template="..." (por alguna extraña razón) copiará esa plantilla completa en la carpeta del proveedor junto con las plantillas originales, y por lo tanto, la estructura de la ruta en template.xml debe permanecer lo mismo. Solo necesitas cambiar por ejemplo. templates/clean/ to templates/yourtemplatename/ .

Tengo un problema con el almacenamiento en caché sin embargo. No puedo volver a leer mi plantilla cada vez. Lo ha guardado en algún lugar y no puedo, por mi vida, averiguar dónde. La documentación es realmente mala y la fuente es peor.

Actualización: Finalmente descubrí que almacenaba en caché mi plantilla en la carpeta temporal de mi computadora. Para Windows, por ejemplo: c:/Users/<username>/AppData/Local/Temp/phpdoc-twig-cache/ . Así que acabo de borrar toda la carpeta.