From 51b95ec8670af41009e2b2b56873bad96682413e Mon Sep 17 00:00:00 2001 From: Ondrej Mirtes Date: Sat, 7 Sep 2024 22:12:41 +0200 Subject: [PATCH] Deploy API Reference into a subdirectory with the current branch name --- .github/workflows/apiref.yml | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/apiref.yml b/.github/workflows/apiref.yml index a315a699..24e6cd97 100644 --- a/.github/workflows/apiref.yml +++ b/.github/workflows/apiref.yml @@ -36,7 +36,7 @@ jobs: run: "composer install --no-interaction --no-progress" - name: "Run ApiGen" - run: "apigen/vendor/bin/apigen -c apigen/apigen.neon --output docs -- src" + run: "apigen/vendor/bin/apigen -c apigen/apigen.neon --output docs/${{ github.ref_name }} -- src" - name: "Copy favicon" run: "cp apigen/favicon.png docs/favicon.png" diff --git a/README.md b/README.md index 3b321b22..a522228e 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ For the complete list of supported PHPDoc features check out PHPStan documentati * [PHPDoc Basics](https://phpstan.org/writing-php-code/phpdocs-basics) (list of PHPDoc tags) * [PHPDoc Types](https://phpstan.org/writing-php-code/phpdoc-types) (list of PHPDoc types) -* [phpdoc-parser API Reference](https://phpstan.github.io/phpdoc-parser/namespace-PHPStan.PhpDocParser.html) with all the AST node types etc. +* [phpdoc-parser API Reference](https://phpstan.github.io/phpdoc-parser/1.23.x/namespace-PHPStan.PhpDocParser.html) with all the AST node types etc. This parser also supports parsing [Doctrine Annotations](https://github.com/doctrine/annotations). The AST nodes live in the [PHPStan\PhpDocParser\Ast\PhpDoc\Doctrine namespace](https://phpstan.github.io/phpdoc-parser/namespace-PHPStan.PhpDocParser.Ast.PhpDoc.Doctrine.html). The support needs to be turned on by setting `bool $parseDoctrineAnnotations` to `true` in `Lexer` and `PhpDocParser` class constructors.