Skip to content

Moving phpdoc template to subfolder #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Hackwar wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Moving phpdoc template to subfolder #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c3dd7ca
Moving phpdoc template to subfolder
Hackwar Mar 19, 2026
3d3f493
Update .gitignore
Hackwar Mar 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .drone.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -143,6 +143,6 @@ trigger:

---
kind: signature
hmac: a002e30e04f1c87e97ac1d7ca091e3a71f5d958b15cb162c91a2e6200701f48b
hmac: 67087323497814e16bc3178c5c4bd9a792c848753058015b6dc094aecd127f84

...
2 changes: 1 addition & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.DS_Store
.idea

/.phpdoc/
/.phpdoc/cache/
/api-docs/
/build/
/repos/
Expand Down
142 changes: 71 additions & 71 deletions base/class.sidebar.html.twig → ...doc/template/base/class.sidebar.html.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,71 +1,71 @@
{% use 'base/sidebar.html.twig' %}
{% block sidebar_buttons %}
<div class="btn-group visibility" data-toggle="buttons-checkbox">
<button class="btn public active" title="Show public elements">Public</button>
<button class="btn protected" title="Show protected elements">Protected</button>
<button class="btn private" title="Show private elements">Private</button>
<button class="btn inherited active" title="Show inherited elements">Inherited</button>
</div>
{% endblock %}
{% block sidebar_entry %}
<li class="{{ type }} {{ item.visibility }}{{ item.parent.name != node.name ? ' inherited' : '' }}">
<a href="{{ link(node) }}#{{ type }}_{{ item.name }}" title="{{ item.name }} :: {{ item.summary }}">
<span class="methodName">{{ item.name }}</span>
</a>
</li>
{% endblock %}
{% block sidebar_content %}
<ul class="side-nav nav nav-list">
<li class="nav-header">
Methods
<ul>
{% set specialMethods = node.magicMethods ? node.inheritedMethods.merge(node.magicMethods) : node.inheritedMethods %}
{% for item in node.methods.merge(specialMethods)|sort_asc %}
{% set type = 'method' %}
{% if item.visibility == '' or item.visibility == 'public' %}
{{ block('sidebar_entry') }}
{% endif %}
{% endfor %}
</ul>
</li>
<li class="nav-header protected">» Protected
<ul>
{% set specialMethods = node.magicMethods ? node.inheritedMethods.merge(node.magicMethods) : node.inheritedMethods %}
{% for item in node.methods.merge(specialMethods)|sort_asc %}
{% set type = 'method' %}
{% if item.visibility == 'protected' %}
{{ block('sidebar_entry') }}
{% endif %}
{% endfor %}
</ul>
</li>
<li class="nav-header private">» Private
<ul>
{% set specialMethods = node.magicMethods ? node.inheritedMethods.merge(node.magicMethods) : node.inheritedMethods %}
{% for method in node.methods.merge(specialMethods)|sort_asc %}
{% set type = 'method' %}
{% if item.visibility == 'private' %}
{{ block('sidebar_entry') }}
{% endif %}
{% endfor %}
</ul>
</li>
<li class="nav-header">
Constants
{% if node.constants.merge(node.inheritedConstants)|length > 0 %}
<ul>
{% for constant in node.constants.merge(node.inheritedConstants)|sort_asc %}
<li class="constant {{ constant.visibility }}">
<a href="{{ link(node) }}#constant_{{ constant.name }}" title="{{ constant.name }} :: {{ constant.summary }}">
<pre>{{ constant.name }}</pre>
</a>
</li>
{% endfor %}
</ul>
{% endif %}
</li>
</ul>
{% endblock %}
{% use 'base/sidebar.html.twig' %}

{% block sidebar_buttons %}
<div class="btn-group visibility" data-toggle="buttons-checkbox">
<button class="btn public active" title="Show public elements">Public</button>
<button class="btn protected" title="Show protected elements">Protected</button>
<button class="btn private" title="Show private elements">Private</button>
<button class="btn inherited active" title="Show inherited elements">Inherited</button>
</div>
{% endblock %}

{% block sidebar_entry %}
<li class="{{ type }} {{ item.visibility }}{{ item.parent.name != node.name ? ' inherited' : '' }}">
<a href="{{ link(node) }}#{{ type }}_{{ item.name }}" title="{{ item.name }} :: {{ item.summary }}">
<span class="methodName">{{ item.name }}</span>
</a>
</li>
{% endblock %}

{% block sidebar_content %}
<ul class="side-nav nav nav-list">
<li class="nav-header">
Methods
<ul>
{% set specialMethods = node.magicMethods ? node.inheritedMethods.merge(node.magicMethods) : node.inheritedMethods %}
{% for item in node.methods.merge(specialMethods)|sort_asc %}
{% set type = 'method' %}
{% if item.visibility == '' or item.visibility == 'public' %}
{{ block('sidebar_entry') }}
{% endif %}
{% endfor %}
</ul>
</li>
<li class="nav-header protected">» Protected
<ul>
{% set specialMethods = node.magicMethods ? node.inheritedMethods.merge(node.magicMethods) : node.inheritedMethods %}
{% for item in node.methods.merge(specialMethods)|sort_asc %}
{% set type = 'method' %}
{% if item.visibility == 'protected' %}
{{ block('sidebar_entry') }}
{% endif %}
{% endfor %}
</ul>
</li>
<li class="nav-header private">» Private
<ul>
{% set specialMethods = node.magicMethods ? node.inheritedMethods.merge(node.magicMethods) : node.inheritedMethods %}
{% for method in node.methods.merge(specialMethods)|sort_asc %}
{% set type = 'method' %}
{% if item.visibility == 'private' %}
{{ block('sidebar_entry') }}
{% endif %}
{% endfor %}
</ul>
</li>
<li class="nav-header">
Constants
{% if node.constants.merge(node.inheritedConstants)|length > 0 %}
<ul>
{% for constant in node.constants.merge(node.inheritedConstants)|sort_asc %}
<li class="constant {{ constant.visibility }}">
<a href="{{ link(node) }}#constant_{{ constant.name }}" title="{{ constant.name }} :: {{ constant.summary }}">
<pre>{{ constant.name }}</pre>
</a>
</li>
{% endfor %}
</ul>
{% endif %}
</li>
</ul>
{% endblock %}
6 changes: 3 additions & 3 deletions base/macros.html.twig → .phpdoc/template/base/macros.html.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{% for file in files %}
{% set count = count + file.markers|length %}
{% endfor %}
<span class="label label-info">{{ count }}</span>
<span class="badge badge-info">{{ count }}</span>
{% endmacro %}

{% macro renderErrorCounter(files) %}
Expand All @@ -15,7 +15,7 @@
{% endif %}
{% endfor %}
{% endfor %}
<span class="label label-info">{{ count }}</span>
<span class="badge badge-info">{{ count }}</span>
{% endmacro %}

{% macro renderDeprecatedCounter(elements) %}
Expand All @@ -25,7 +25,7 @@
{% set count = count + element.tags.deprecated.count %}
{% endif %}
{% endfor %}
<span class="label label-info">{{ count }}</span>
<span class="badge badge-info">{{ count }}</span>
{% endmacro %}

{% macro buildBreadcrumb(element) %}
Expand Down
0 base/sidebar.html.twig → .phpdoc/template/base/sidebar.html.twig
View file
Open in desktop
File renamed without changes.
6 changes: 3 additions & 3 deletions class.html.twig → .phpdoc/template/class.html.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@
{% endblock %}

{% block content %}
<div class="row-fluid">
<aside class="span5">
<div class="row">
<aside class="col-md-5">
{{ block('sidebar') }}
</aside>

<main class="span7">
<main class="col-md-7">
<div class="element element--class">
{% include 'class/base.element.html.twig' with {'node': node, 'type': 'class'} %}
</div>
Expand Down
Loading