From c3dd7cade77fa90e20f193a153f6dac0ac0de51c Mon Sep 17 00:00:00 2001 From: Hannes Papenberg Date: Thu, 19 Mar 2026 13:16:28 +0100 Subject: [PATCH 1/2] Moving phpdoc template to subfolder --- .drone.yml | 6 +- .../template/base}/class.sidebar.html.twig | 142 ++++----- .../template/base}/macros.html.twig | 6 +- .../template/base}/sidebar.html.twig | 0 .../template/class.html.twig | 6 +- .../template/class}/base.element.html.twig | 194 +++++------ .../template/class}/constant.html.twig | 140 ++++---- .../template/class}/details.method.html.twig | 132 ++++---- .../template/class}/method.html.twig | 48 +-- .../template/class}/property.html.twig | 132 ++++---- .../template/graphs}/class.html.twig | 2 +- .phpdoc/template/index.html.twig | 72 +++++ .../template/interface.html.twig | 6 +- .phpdoc/template/layout.html.twig | 300 ++++++++++++++++++ .../template/namespace.html.twig | 6 +- .../template/package.html.twig | 6 +- .../template/reports}/deprecated.html.twig | 8 +- .../template/reports}/errors.html.twig | 8 +- .../template/reports}/markers.html.twig | 8 +- template.xml => .phpdoc/template/template.xml | 26 +- .../template/trait.html.twig | 6 +- index.html.twig | 60 ---- layout.html.twig | 283 ----------------- 23 files changed, 814 insertions(+), 783 deletions(-) rename {base => .phpdoc/template/base}/class.sidebar.html.twig (97%) rename {base => .phpdoc/template/base}/macros.html.twig (93%) rename {base => .phpdoc/template/base}/sidebar.html.twig (100%) rename class.html.twig => .phpdoc/template/class.html.twig (89%) rename {class => .phpdoc/template/class}/base.element.html.twig (97%) rename {class => .phpdoc/template/class}/constant.html.twig (98%) rename {class => .phpdoc/template/class}/details.method.html.twig (98%) rename {class => .phpdoc/template/class}/method.html.twig (98%) rename {class => .phpdoc/template/class}/property.html.twig (98%) rename {graphs => .phpdoc/template/graphs}/class.html.twig (97%) create mode 100644 .phpdoc/template/index.html.twig rename interface.html.twig => .phpdoc/template/interface.html.twig (89%) create mode 100644 .phpdoc/template/layout.html.twig rename namespace.html.twig => .phpdoc/template/namespace.html.twig (97%) rename package.html.twig => .phpdoc/template/package.html.twig (97%) rename {reports => .phpdoc/template/reports}/deprecated.html.twig (94%) rename {reports => .phpdoc/template/reports}/errors.html.twig (94%) rename {reports => .phpdoc/template/reports}/markers.html.twig (93%) rename template.xml => .phpdoc/template/template.xml (55%) rename trait.html.twig => .phpdoc/template/trait.html.twig (89%) delete mode 100644 index.html.twig delete mode 100644 layout.html.twig diff --git a/.drone.yml b/.drone.yml index 2356f8c..8957b88 100644 --- a/.drone.yml +++ b/.drone.yml @@ -90,13 +90,13 @@ steps: commands: - | if [ "$JTYPE" = "framework" ]; then - phpdoc -d "./repos/*/src" -t "./build/framework-$JVERSION/" --cache-folder "/tmp/phpdocumentor-cache" --template "./" --title "Joomla! Framework $JVERSION.x API" -i "./repos/string/src/phputf8" --defaultpackagename "Joomla Framework" --setting=graphs.enabled=true --setting=guides.enabled=true + phpdoc -d "./repos/*/src" -t "./build/framework-$JVERSION/" --cache-folder "/tmp/phpdocumentor-cache" --template "./.phpdoc/template" --title "Joomla! Framework $JVERSION.x API" -i "./repos/string/src/phputf8" --defaultpackagename "Joomla Framework" --setting=graphs.enabled=true --setting=guides.enabled=true fi - | if [ "$JTYPE" = "cms" ]; then export MINORVERSION=${JVERSION%.*} export MAJORVERSION=${JVERSION:0:1} - phpdoc -d "./repos/joomla-cms/libraries/src" -t "./build/cms-$MAJORVERSION/" --cache-folder "/tmp/phpdocumentor-cache" --template "./" --title "Joomla! CMS $MINORVERSION.x API" --defaultpackagename "Joomla CMS" --setting=graphs.enabled=true --setting=guides.enabled=true + phpdoc -d "./repos/joomla-cms/libraries/src" -t "./build/cms-$MAJORVERSION/" --cache-folder "/tmp/phpdocumentor-cache" --template "./.phpdoc/template" --title "Joomla! CMS $MINORVERSION.x API" --defaultpackagename "Joomla CMS" --setting=graphs.enabled=true --setting=guides.enabled=true fi - name: deploy_documentation @@ -143,6 +143,6 @@ trigger: --- kind: signature -hmac: a002e30e04f1c87e97ac1d7ca091e3a71f5d958b15cb162c91a2e6200701f48b +hmac: 67087323497814e16bc3178c5c4bd9a792c848753058015b6dc094aecd127f84 ... diff --git a/base/class.sidebar.html.twig b/.phpdoc/template/base/class.sidebar.html.twig similarity index 97% rename from base/class.sidebar.html.twig rename to .phpdoc/template/base/class.sidebar.html.twig index a2c5ba9..c598217 100644 --- a/base/class.sidebar.html.twig +++ b/.phpdoc/template/base/class.sidebar.html.twig @@ -1,71 +1,71 @@ -{% use 'base/sidebar.html.twig' %} - -{% block sidebar_buttons %} -
- - - - -
-{% endblock %} - -{% block sidebar_entry %} -
  • - - {{ item.name }} - -
    • -{% endblock %} - -{% block sidebar_content %} - -{% endblock %} +{% use 'base/sidebar.html.twig' %} + +{% block sidebar_buttons %} +
    + + + + +
    +{% endblock %} + +{% block sidebar_entry %} +
  • + + {{ item.name }} + +
    • +{% endblock %} + +{% block sidebar_content %} + +{% endblock %} diff --git a/base/macros.html.twig b/.phpdoc/template/base/macros.html.twig similarity index 93% rename from base/macros.html.twig rename to .phpdoc/template/base/macros.html.twig index b6bd14c..06491c8 100644 --- a/base/macros.html.twig +++ b/.phpdoc/template/base/macros.html.twig @@ -3,7 +3,7 @@ {% for file in files %} {% set count = count + file.markers|length %} {% endfor %} - {{ count }} + {{ count }} {% endmacro %} {% macro renderErrorCounter(files) %} @@ -15,7 +15,7 @@ {% endif %} {% endfor %} {% endfor %} - {{ count }} + {{ count }} {% endmacro %} {% macro renderDeprecatedCounter(elements) %} @@ -25,7 +25,7 @@ {% set count = count + element.tags.deprecated.count %} {% endif %} {% endfor %} - {{ count }} + {{ count }} {% endmacro %} {% macro buildBreadcrumb(element) %} diff --git a/base/sidebar.html.twig b/.phpdoc/template/base/sidebar.html.twig similarity index 100% rename from base/sidebar.html.twig rename to .phpdoc/template/base/sidebar.html.twig diff --git a/class.html.twig b/.phpdoc/template/class.html.twig similarity index 89% rename from class.html.twig rename to .phpdoc/template/class.html.twig index 78bded3..2c50d47 100644 --- a/class.html.twig +++ b/.phpdoc/template/class.html.twig @@ -8,12 +8,12 @@ {% endblock %} {% block content %} -
    -