-
-
Notifications
You must be signed in to change notification settings - Fork 504
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: Validate documentation rst with phpdocumentor #2646
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
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: "Install dependencies with Composer" | ||
uses: "ramsey/composer-install@v3" | ||
with: | ||
working-directory: "docs" | ||
dependency-versions: "highest" | ||
|
||
- name: "Add orphan metadata where needed" | ||
run: | | ||
printf '%s\n\n%s\n' ":orphan:" "$(cat docs/en/sidebar.rst)" > docs/en/sidebar.rst | ||
|
||
- name: "Run guides-cli" | ||
run: "docs/vendor/bin/guides -vvv --no-progress docs/en 2>&1 | grep -v 'No template found for rendering directive' | ( ! grep WARNING )" |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"require-dev": { | ||
"phpdocumentor/guides-cli": "^1.2" | ||
} | ||
} |
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 <[email protected]> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
||
This recipe will show you how to implement ArrayAccess for your | ||
domain objects in order to allow more uniform access, for example | ||
|
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 <[email protected]> | ||
|
||
The NOTIFY change-tracking policy is the most effective | ||
change-tracking policy provided by Doctrine but it requires some | ||
|
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 <[email protected]> | ||
|
||
As explained in the | ||
:doc:`restrictions for document classes in the manual <../reference/architecture>`. | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -94,3 +94,6 @@ type in your mapping like this: | |
.. code-block:: xml | ||
|
||
<field field-name="field" type="mytype" /> | ||
|
||
.. |FQCN| raw:: html | ||
<abbr title="Fully-Qualified Class Name">FQCN</abbr> | ||
Comment on lines
+98
to
+99
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Noted that this was adapated from the ORM action.