Skip to content

Conversation

@adriendupuis
Copy link
Contributor

@adriendupuis adriendupuis commented Feb 23, 2023

Question Answer
JIRA Ticket IBX-4929
Versions master, 4.6, 4.x, 3.3
Edition Commerce (All)
  • Generate and serve a PHP API reference
  • Links to this PHP API reference instead of GitHub

TODO:

Checklist

  • Text renders correctly
  • Text has been checked with vale
  • Description metadata is up to date
  • Redirects cover removed/moved pages
  • Code samples are working
  • PHP code samples have been fixed with PHP CS fixer
  • Added link to this PR in relevant JIRA ticket or code PR

The classes in the following directories do not seem useful for final customer

- vendor/ibexa/fieldtype-query/spec
- vendor/ibexa/graphql/spec
- vendor/ibexa/http-cache/spec
It is done by ContentService::loadVersions(ContentInfo $contentInfo, int $status=null): VersionInfo[]
WARNING  -  Documentation file 'api/php_api/php_api.md' contains a link to 'api/php_api_reference/classes/Ibexa-Contracts-CorporateAccount-Service-CompanyService.html' which is not found in the documentation files.
Avoid `mkdocs serve` to crash during removal with such error:
`FileNotFoundError: [Errno 2] No such file or directory: 'docs/api/php_api/php_api_reference/files/vendor-ibexa-admin-ui-assets-src-bundle-ibexaadminuiassetsbundle.html'`
GrabowskiM and others added 5 commits May 28, 2024 15:09
# Conflicts:
#	docs/api/php_api/php_api.md
---------

Co-authored-by: Tomasz Dąbrowski <64841871+dabrt@users.noreply.github.com>
---------

Co-authored-by: Tomasz Dąbrowski <64841871+dabrt@users.noreply.github.com>
Copy link
Contributor

@dabrt dabrt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please consider applying my suggested changes.

adriendupuis and others added 19 commits May 29, 2024 09:21
Co-authored-by: Tomasz Dąbrowski <64841871+dabrt@users.noreply.github.com>
Only space changes.
`git diff --ignore-all-space --ignore-blank-lines docs/api/php_api/php_api_reference` doesn't find any changes.
Cannot read properties of undefined (reading 'scrollIntoView')
---------

Co-authored-by: Adrien Dupuis <adrien.dupuis@ibexa.co>
Co-authored-by: Michał Grabowski <michal.grabowski@ibexa.co>
Co-authored-by: Tomasz Dąbrowski <64841871+dabrt@users.noreply.github.com>
Co-authored-by: julitafalcondusza <117284672+julitafalcondusza@users.noreply.github.com>
@adriendupuis adriendupuis marked this pull request as ready for review May 30, 2024 18:29
@adriendupuis adriendupuis merged commit 939daf1 into master May 31, 2024
@adriendupuis adriendupuis deleted the php_api_ref branch May 31, 2024 07:09
adriendupuis added a commit that referenced this pull request May 31, 2024
* Add a script to generate a PHP API reference
* Generate PHP API reference's HTML
* Add PHP API reference to the API chapter
* Links to PHP API reference

---------

Co-authored-by: Adrien Dupuis <adrien.dupuis@ibexa.co>
Co-authored-by: Michał Grabowski <michal.grabowski@ibexa.co>
Co-authored-by: Tomasz Dąbrowski <64841871+dabrt@users.noreply.github.com>
Co-authored-by: julitafalcondusza <117284672+julitafalcondusza@users.noreply.github.com>
(cherry picked from commit 939daf1)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants