Add phpDocumentor tooling

This commit is contained in:
Sebastian Meyer 2024-01-23 17:59:30 +01:00
parent ca19810a56
commit be3b5f1141
4 changed files with 54 additions and 0 deletions

2
.gitignore vendored
View File

@ -1,6 +1,8 @@
/.phpdoc/cache/
/.vscode/ /.vscode/
/vendor/ /vendor/
.php-cs-fixer.php .php-cs-fixer.php
composer.lock composer.lock
phpcs.xml phpcs.xml
phpdoc.xml
phpstan.neon phpstan.neon

0
.phpdoc/guide/index.rst Normal file
View File

View File

@ -0,0 +1,14 @@
{% extends 'layout.html.twig' %}
{%
set topMenu = {
"menu": [
{ "name": "Packagist", "url": "https://packagist.org/packages/opencultureconsulting/basics"}
],
"social": [
{ "iconClass": "fab fa-github", "url": "https://github.com/opencultureconsulting/php-basics"},
{ "iconClass": "fab fa-mastodon", "url": "https://openbiblio.social/@occ"},
{ "iconClass": "fas fa-envelope-open-text", "url": "mailto:office@opencultureconsulting.com"}
]
}
%}

38
phpdoc.dist.xml Normal file
View File

@ -0,0 +1,38 @@
<?xml version="1.0" encoding="UTF-8" ?>
<phpdocumentor
configVersion="3"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="https://www.phpdoc.org"
xsi:schemaLocation="https://www.phpdoc.org https://raw.githubusercontent.com/phpDocumentor/phpDocumentor/master/data/xsd/phpdoc.xsd">
<title>PHP Basics</title>
<paths>
<output>doc</output>
<cache>.phpdoc/cache</cache>
</paths>
<version number="latest">
<api format="php">
<source dsn=".">
<path>/src</path>
</source>
<extensions>
<extension>php</extension>
</extensions>
<default-package-name>Basics</default-package-name>
<include-source>true</include-source>
<ignore-tags>
<ignore-tag>extends</ignore-tag>
<ignore-tag>implements</ignore-tag>
<ignore-tag>phpstan-require-implements</ignore-tag>
</ignore-tags>
</api>
<guide>
<source dsn=".">
<path>/.phpdoc/guide</path>
</source>
<output>guides</output>
</guide>
</version>
<setting name="graphs.enabled" value="true"/>
<setting name="guides.enabled" value="true"/>
<setting name="template.color" value="orange"/>
</phpdocumentor>