* Add API documentation generation with phpDocumentor - Add phpDocumentor configuration and `docs` Makefile target - Generate docs during CI to catch errors before releases - Set up GitHub Pages with Jekyll for hosting generated docs - Add GitHub Actions workflow to deploy docs to GitHub Pages on releases 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Fix phpDocumentor errors in type annotations Change class-string union types to use phpDocumentor-compatible syntax and reorder docblock tags so class descriptions precede `@author` tags. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Fix CI: pin phar-io/composer-distributor ^1.0.2 phar-io/composer-distributor 1.0.0 has a bug where it uses the wrong package version when determining the phpDocumentor download URL, causing CI to fail with 404 errors when using --prefer-lowest. Version 1.0.2 fixes this issue. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Integrate markdown guides into phpDocumentor output Configure phpDocumentor to generate both API documentation and user guides in a single unified site. This replaces the previous Jekyll-based approach where API docs were copied into the docs folder. - Add `<guide>` configuration to `phpdoc.dist.xml` - Create custom template with "Guides" navigation link - Replace `docs/index.html` redirect with `docs/index.md` guide index - Update workflow to publish `build/docs` directly without Jekyll - Track `.phpdoc/template/` while still ignoring `.phpdoc/cache/` 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Fine-tuning for path, config, and layout --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Co-authored-by: Christopher Hertel <mail@christopher-hertel.de>
44 lines
1.5 KiB
XML
44 lines
1.5 KiB
XML
<?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:noNamespaceSchemaLocation="https://docs.phpdoc.org/latest/phpdoc.xsd"
|
|
>
|
|
<title>MCP PHP SDK</title>
|
|
<paths>
|
|
<output>.phpdoc/build</output>
|
|
</paths>
|
|
<version number="latest">
|
|
<folder>latest</folder>
|
|
<api ignore-packages="true">
|
|
<source dsn=".">
|
|
<path>src</path>
|
|
</source>
|
|
<output>api</output>
|
|
<ignore>
|
|
<path>vendor/**/*</path>
|
|
<path>tests/**/*</path>
|
|
</ignore>
|
|
<ignore-tags>
|
|
<ignore-tag>phpstan-type</ignore-tag>
|
|
<ignore-tag>phpstan-type-import</ignore-tag>
|
|
<ignore-tag>template</ignore-tag>
|
|
<ignore-tag>template-covariant</ignore-tag>
|
|
<ignore-tag>template-extends</ignore-tag>
|
|
<ignore-tag>template-implements</ignore-tag>
|
|
<ignore-tag>extends</ignore-tag>
|
|
<ignore-tag>implements</ignore-tag>
|
|
</ignore-tags>
|
|
</api>
|
|
<guide format="md">
|
|
<source dsn=".">
|
|
<path>docs</path>
|
|
</source>
|
|
<output>/</output>
|
|
</guide>
|
|
</version>
|
|
<setting name="guides.enabled" value="true"/>
|
|
<setting name="graphs.enabled" value="false"/>
|
|
<setting name="template.color" value="black"/>
|
|
</phpdocumentor>
|