-
-
Notifications
You must be signed in to change notification settings - Fork 504
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Validate documentation rst with phpdocumentor
- Loading branch information
Showing
7 changed files
with
53 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
name: "Documentation" | ||
|
||
on: | ||
pull_request: | ||
branches: | ||
- "*.x" | ||
paths: | ||
- .github/workflows/documentation.yml | ||
- docs/** | ||
push: | ||
branches: | ||
- "*.x" | ||
paths: | ||
- .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 )" |
2 changes: 1 addition & 1 deletion
2
docs/en/cookbook/implementing-array-access-for-domain-objects.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
Implementing ArrayAccess for Domain Objects | ||
=========================================== | ||
|
||
.. sectionauthor:: Roman Borschel ([email protected]) | ||
.. sectionauthor:: Roman Borschel | ||
|
||
This recipe will show you how to implement ArrayAccess for your | ||
domain objects in order to allow more uniform access, for example | ||
|
2 changes: 1 addition & 1 deletion
2
docs/en/cookbook/implementing-the-notify-changetracking-policy.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
Implementing the Notify ChangeTracking Policy | ||
============================================= | ||
|
||
.. sectionauthor:: Roman Borschel ([email protected]) | ||
.. sectionauthor:: Roman Borschel | ||
|
||
The NOTIFY change-tracking policy is the most effective | ||
change-tracking policy provided by Doctrine but it requires some | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
Implementing Wakeup or Clone | ||
============================ | ||
|
||
.. sectionauthor:: Roman Borschel ([email protected]) | ||
.. sectionauthor:: Roman Borschel | ||
|
||
As explained in the | ||
:doc:`restrictions for document classes in the manual <../reference/architecture>`. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,7 +4,7 @@ Validation of Documents | |
Validation of Documents - Application Side | ||
------------------------------------------ | ||
|
||
.. sectionauthor:: Benjamin Eberlei <[email protected]> | ||
.. sectionauthor:: Benjamin Eberlei | ||
|
||
Doctrine does not ship with any internal validators, the reason | ||
being that we think all the frameworks out there already ship with | ||
|
@@ -135,7 +135,7 @@ Further readings: :doc:`Lifecycle Events <../reference/events>` | |
Validation of Documents - Database Side | ||
--------------------------------------- | ||
|
||
.. sectionauthor:: Alexandre Abrioux <[email protected]> | ||
.. sectionauthor:: Alexandre Abrioux | ||
|
||
.. note:: | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
:orphan: | ||
.. toc:: | ||
|
||
.. tocheader:: Tutorials | ||
|