diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 0000000..e9b2c71 --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,20 @@ +name: "Documentation" + +on: + pull_request: + branches: + - "*.x" + paths: + - ".github/workflows/documentation.yml" + - "docs/**" + push: + branches: + - "*.x" + paths: + - ".github/workflows/documentation.yml" + - "docs/**" + +jobs: + documentation: + name: "Documentation" + uses: "doctrine/.github/.github/workflows/documentation.yml@5.1.0" diff --git a/.gitignore b/.gitignore index 1600343..2dbfde8 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,6 @@ /phpcs.xml /.phpcs-cache /.phpunit.cache + +# phpDocumentor/guides output directory +/output diff --git a/composer.json b/composer.json index 4ea788b..f276d39 100644 --- a/composer.json +++ b/composer.json @@ -42,6 +42,7 @@ }, "require-dev": { "doctrine/coding-standard": "^12", + "phpdocumentor/guides-cli": "^1.4", "phpstan/phpstan": "^1.8.8", "phpunit/phpunit": "^10.5", "vimeo/psalm": "^5.24" diff --git a/docs/en/sidebar.rst b/docs/en/sidebar.rst index 0672d8d..206e752 100644 --- a/docs/en/sidebar.rst +++ b/docs/en/sidebar.rst @@ -1,3 +1,5 @@ +:orphan: + .. toctree:: :depth: 3