From cc28fed9f51f24b7d0677d97b7ad67bc342bf728 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gr=C3=A9goire=20Paris?= Date: Tue, 8 Oct 2024 14:41:35 +0200 Subject: [PATCH] Replace custom directives with native option --- .github/workflows/documentation.yml | 38 ++----- docs/en/sidebar.rst | 149 +++++++++++++--------------- 2 files changed, 77 insertions(+), 110 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 96caa7eba00..e9b2c71857d 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -5,40 +5,16 @@ on: branches: - "*.x" paths: - - .github/workflows/documentation.yml - - docs/** + - ".github/workflows/documentation.yml" + - "docs/**" push: branches: - "*.x" paths: - - .github/workflows/documentation.yml - - docs/** + - ".github/workflows/documentation.yml" + - "docs/**" jobs: - validate-with-guides: - name: "Validate documentation with phpDocumentor/guides" - runs-on: "ubuntu-22.04" - - steps: - - name: "Checkout code" - uses: "actions/checkout@v4" - - - name: "Install PHP" - uses: "shivammathur/setup-php@v2" - with: - coverage: "none" - php-version: "8.3" - - - name: "Remove existing composer file" - run: "rm composer.json" - - - name: "Require phpdocumentor/guides-cli" - run: "composer require --dev phpdocumentor/guides-cli --no-update" - - - name: "Install dependencies with Composer" - uses: "ramsey/composer-install@v3" - with: - dependency-versions: "highest" - - - name: "Run guides-cli" - run: "vendor/bin/guides -vvv --no-progress docs/en 2>&1 | grep -v 'No template found for rendering directive' | ( ! grep WARNING )" + documentation: + name: "Documentation" + uses: "doctrine/.github/.github/workflows/documentation.yml@5.1.0" diff --git a/docs/en/sidebar.rst b/docs/en/sidebar.rst index f67304e8457..b94c81fdd48 100644 --- a/docs/en/sidebar.rst +++ b/docs/en/sidebar.rst @@ -1,86 +1,77 @@ :orphan: -.. toc:: +.. toctree:: + :caption: Tutorials + :depth: 3 - .. tocheader:: Tutorials + tutorials/getting-started + tutorials/getting-started-database + tutorials/getting-started-models + tutorials/working-with-indexed-associations + tutorials/extra-lazy-associations + tutorials/composite-primary-keys + tutorials/ordered-associations + tutorials/override-field-association-mappings-in-subclasses + tutorials/pagination + tutorials/embeddables - .. toctree:: - :depth: 3 +.. toctree:: + :caption: Reference + :depth: 3 - tutorials/getting-started - tutorials/getting-started-database - tutorials/getting-started-models - tutorials/working-with-indexed-associations - tutorials/extra-lazy-associations - tutorials/composite-primary-keys - tutorials/ordered-associations - tutorials/override-field-association-mappings-in-subclasses - tutorials/pagination - tutorials/embeddables + reference/architecture + reference/configuration + reference/faq + reference/basic-mapping + reference/association-mapping + reference/inheritance-mapping + reference/working-with-objects + reference/working-with-associations + reference/typedfieldmapper + reference/events + reference/unitofwork + reference/unitofwork-associations + reference/transactions-and-concurrency + reference/batch-processing + reference/dql-doctrine-query-language + reference/query-builder + reference/native-sql + reference/change-tracking-policies + reference/partial-objects + reference/annotations-reference + reference/attributes-reference + reference/xml-mapping + reference/yaml-mapping + reference/php-mapping + reference/caching + reference/improving-performance + reference/tools + reference/metadata-drivers + reference/best-practices + reference/limitations-and-known-issues + tutorials/pagination + reference/filters + reference/namingstrategy + reference/advanced-configuration + reference/second-level-cache + reference/security -.. toc:: +.. toctree:: + :caption: Cookbook + :depth: 3 - .. tocheader:: Reference - - .. toctree:: - :depth: 3 - - reference/architecture - reference/configuration - reference/faq - reference/basic-mapping - reference/association-mapping - reference/inheritance-mapping - reference/working-with-objects - reference/working-with-associations - reference/typedfieldmapper - reference/events - reference/unitofwork - reference/unitofwork-associations - reference/transactions-and-concurrency - reference/batch-processing - reference/dql-doctrine-query-language - reference/query-builder - reference/native-sql - reference/change-tracking-policies - reference/partial-objects - reference/annotations-reference - reference/attributes-reference - reference/xml-mapping - reference/yaml-mapping - reference/php-mapping - reference/caching - reference/improving-performance - reference/tools - reference/metadata-drivers - reference/best-practices - reference/limitations-and-known-issues - tutorials/pagination - reference/filters - reference/namingstrategy - reference/advanced-configuration - reference/second-level-cache - reference/security - -.. toc:: - - .. tocheader:: Cookbook - - .. toctree:: - :depth: 3 - - cookbook/aggregate-fields - cookbook/custom-mapping-types - cookbook/decorator-pattern - cookbook/dql-custom-walkers - cookbook/dql-user-defined-functions - cookbook/implementing-arrayaccess-for-domain-objects - cookbook/implementing-the-notify-changetracking-policy - cookbook/resolve-target-entity-listener - cookbook/sql-table-prefixes - cookbook/strategy-cookbook-introduction - cookbook/validation-of-entities - cookbook/working-with-datetime - cookbook/mysql-enums - cookbook/advanced-field-value-conversion-using-custom-mapping-types - cookbook/entities-in-session + cookbook/aggregate-fields + cookbook/custom-mapping-types + cookbook/decorator-pattern + cookbook/dql-custom-walkers + cookbook/dql-user-defined-functions + cookbook/implementing-arrayaccess-for-domain-objects + cookbook/implementing-the-notify-changetracking-policy + cookbook/resolve-target-entity-listener + cookbook/sql-table-prefixes + cookbook/strategy-cookbook-introduction + cookbook/validation-of-entities + cookbook/working-with-datetime + cookbook/mysql-enums + cookbook/advanced-field-value-conversion-using-custom-mapping-types + cookbook/entities-in-session