-
Notifications
You must be signed in to change notification settings - Fork 79
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[TASK] Switch Documentation Rendering to PHP (#737)
You can try out the rendering locally with ``` make docs ```
- Loading branch information
Showing
8 changed files
with
63 additions
and
72 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
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,17 @@ | ||
name: test documentation | ||
|
||
on: [ push, pull_request ] | ||
|
||
jobs: | ||
tests: | ||
name: documentation | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
|
||
- name: Test if the documentation will render without warnings | ||
run: | | ||
mkdir -p Documentation-GENERATED-temp \ | ||
&& docker run --rm --pull always -v $(pwd):/project \ | ||
ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log |
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 |
---|---|---|
|
@@ -74,4 +74,3 @@ even if you change the extension in the graphical editor. | |
:hidden: | ||
|
||
Sitemap | ||
genindex |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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,27 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<guides xmlns="https://www.phpdoc.org/guides" | ||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
xsi:schemaLocation="https://www.phpdoc.org/guides ../vendor/phpdocumentor/guides-cli/resources/schema/guides.xsd" | ||
links-are-relative="true"> | ||
<extension class="\T3Docs\Typo3DocsTheme\DependencyInjection\Typo3DocsThemeExtension" | ||
project-home="https://extensions.typo3.org/extension/extension_builder" | ||
project-contact="https://typo3.slack.com/archives/C0CEB3BMY" | ||
project-repository="https://github.com/FriendsOfTYPO3/extension_builder" | ||
project-issues="https://github.com/FriendsOfTYPO3/extension_builder/issues" | ||
edit-on-github-branch="master" | ||
edit-on-github="FriendsOfTYPO3/extension_builder" | ||
typo3-core-preferred="11.5" | ||
interlink-shortcode="friendsoftypo3/extension-builder" | ||
/> | ||
<project title="Extension Builder" | ||
release="main (development)" | ||
version="main (development)" | ||
copyright="since 2009 by the TYPO3 contributors" | ||
/> | ||
<inventory id="t3coreapi-latest" | ||
url="https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/" | ||
/> | ||
<inventory id="t3extbasebook" | ||
url="https://docs.typo3.org/m/typo3/book-extbasefluid/10.4/en-us/" | ||
/> | ||
</guides> |
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,14 @@ | ||
.PHONY: help | ||
help: ## Displays this list of targets with descriptions | ||
@echo "The following commands are available:\n" | ||
@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}' | ||
|
||
.PHONY: docs | ||
docs: ## Generate projects documentation (from "Documentation" directory) | ||
mkdir -p Documentation-GENERATED-temp | ||
docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation | ||
|
||
.PHONY: test-docs | ||
test-docs: ## Test the documentation rendering | ||
mkdir -p Documentation-GENERATED-temp | ||
docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log |