[TASK] Migrate docs to PHP-based rendering #265
Merged
Conversation
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
The Documentation Team introduced the PHP-based rendering (guides) as replacement for the
previously used Sphinx-based rendering (which is now deprecated).
This change migrates the configuration from Settings.cfg to guides.xml.
To generate the docs, a Composer script is introduced:
composer docs:generate
Additionally, a new GitHub Workflow has been added which checks, if there are warnings or errors
on rendering of the documentation.
See: https://typo3.org/article/transition-to-full-php-based-rendering-for-all-typo3-extension-manuals
|
Please rerun the new Documentation workflow. I had that error locally also the first time, but haven't spot an error. All additional runs doesn't reveal that error. |
|
Thanks for the PR! Unfortunately re-running the Documentation workflow doesn't help, it's still failing. |
Okay, thanks. Will have a look again. Strangely, worked on my machine(TM) after restart (and also when throwing away the generated folder). |
christianbltr
added a commit
that referenced
this pull request
Jan 3, 2025
Add "fail-on-log" and "no-progress" options to better match the local rendering of the documentation with the test in the GitHub pipeline. That allows to find rendering issues locally, not only during the pipeline run. see #265
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Documentation Team introduced the PHP-based rendering (guides) as replacement for the previously used Sphinx-based rendering (which is now deprecated).
This change migrates the configuration from Settings.cfg to guides.xml.
To generate the docs, a Composer script is introduced:
Additionally, a new GitHub Workflow has been added which checks, if there are warnings or errors on rendering of the documentation.
See: https://typo3.org/article/transition-to-full-php-based-rendering-for-all-typo3-extension-manuals