diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 00000000000..e9b2c71857d --- /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/docs/en/reference/testing.rst b/docs/en/reference/testing.rst index fdde5b238ff..87f6956700b 100644 --- a/docs/en/reference/testing.rst +++ b/docs/en/reference/testing.rst @@ -85,7 +85,7 @@ We do not currently have specific instructions on how to run a Database server, but we do recommend Docker as a convenient way to do so. We do not recommend running against a particular version of the chosen RDBMS either, as long as you pick one of the -:doc:`officially supported versions `. +:doc:`officially supported versions `. Recommendations on Writing Tests ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/en/sidebar.rst b/docs/en/sidebar.rst index 66c8e2dbed9..6656369d91c 100644 --- a/docs/en/sidebar.rst +++ b/docs/en/sidebar.rst @@ -1,33 +1,31 @@ -.. toc:: +:orphan: - .. tocheader:: Reference +.. toctree:: + :caption: Reference + :depth: 3 - .. toctree:: - :depth: 3 + /reference/introduction + /reference/architecture + /reference/configuration + /reference/data-retrieval-and-manipulation + /reference/query-builder + /reference/transactions + /reference/platforms + /reference/types + /reference/schema-manager + /reference/schema-representation + /reference/security + /reference/supporting-other-databases + /reference/portability + /reference/caching + /reference/known-vendor-issues + /reference/cli-tools + /reference/testing - /reference/introduction - /reference/architecture - /reference/configuration - /reference/data-retrieval-and-manipulation - /reference/query-builder - /reference/transactions - /reference/platforms - /reference/types - /reference/schema-manager - /reference/schema-representation - /reference/security - /reference/supporting-other-databases - /reference/portability - /reference/caching - /reference/known-vendor-issues - /reference/testing -.. toc:: +.. toctree:: + :caption: Explanation + :depth: 3 - .. tocheader:: Explanation - - .. toctree:: - :depth: 3 - - /explanation/dc2type-comments - /explanation/implicit-indexes + /explanation/dc2type-comments + /explanation/implicit-indexes