diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 00000000..90c54d67 --- /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@12.2.0" diff --git a/composer.json b/composer.json index 6e5a5ccf..fedf2061 100644 --- a/composer.json +++ b/composer.json @@ -48,5 +48,8 @@ "dealerdirect/phpcodesniffer-composer-installer": true, "composer/package-versions-deprecated": true } + }, + "scripts": { + "docs": "composer --working-dir docs update && ./docs/vendor/bin/build-docs.sh @additional_args" } } diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 00000000..f26c03fc --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,3 @@ +/composer.lock +/vendor/ +/output/ diff --git a/docs/composer.json b/docs/composer.json new file mode 100644 index 00000000..c5a4e144 --- /dev/null +++ b/docs/composer.json @@ -0,0 +1,5 @@ +{ + "require": { + "doctrine/docs-builder": "^1.0" + } +} diff --git a/docs/en/sidebar.rst b/docs/en/sidebar.rst index f89f2bba..f18d38f4 100644 --- a/docs/en/sidebar.rst +++ b/docs/en/sidebar.rst @@ -1,3 +1,5 @@ +:orphan: + .. toctree:: :depth: 3